{"items":[{"type":"link","label":"Qargo TMS API","link":"/docs","routeSlug":"/docs","content":{"contentType":"overview","meta":{"name":"Qargo TMS API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"docs.json","url":"/_bundle/docs.json?download"},{"kind":"download","label":"docs.yaml","url":"/_bundle/docs.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"payload","title":"Payload","lang":"Payload"},{"key":"python","title":"Python","lang":"Python"},{"key":"js","title":"JS","lang":"JavaScript"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"java","title":"Java","lang":"Java"},{"key":"curl","title":"cURL","lang":"curl"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.qargo.com"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Qargo TMS API (1.2.0)","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":"For support, please contact integrations@qargo.com."},"children":[]}]}]}]}],"sectionId":"/docs"}],"sectionId":"/docs"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/overview"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overview"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"background":"linear-gradient(135deg, #1C2C31 0%, #304045 100%)","color":"white","padding":"20px","borderRadius":"10px","margin":"20px 0"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"h2","attrs":{"style":{"color":"white","marginTop":"0"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Tenant API Documentation"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{"style":{"fontSize":"16px","marginBottom":"0"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"You are currently viewing the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Tenant API Documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". This API provides access to tenant-level integrations and operational endpoints."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"borderLeft":"4px solid #00E85B","background":"#F4FBF7","padding":"14px 18px","borderRadius":"6px","margin":"20px 0"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"What's new"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" — see the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"/docs/section/changelog"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Changelog"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for recent additions and changes to the API.\n"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]}]}],"sectionId":"/docs/section/overview"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/overview/documentation-for-other-parties"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Documentation for Other Parties"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"grid","gridTemplateColumns":"repeat(auto-fit, minmax(300px, 1fr))","gap":"20px","margin":"30px 0"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"border":"2px solid #00E85B","borderRadius":"10px","padding":"20px","background":"#F4FBF7","transition":"transform 0.2s"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"h3","attrs":{"style":{"color":"#36BB6B","marginTop":"0"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Subcontractor API"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Fleet dispatch and subcontractor-specific endpoints for transportation management."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"textAlign":"center","marginTop":"15px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.qargo.com/subcontractor/docs","style":{"display":"inline-block","background":"#00E85B","color":"white","padding":"12px 24px","textDecoration":"none","borderRadius":"6px","fontWeight":"bold","transition":"background 0.3s"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Subcontractor Documentation"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"border":"2px solid #6F82FB","borderRadius":"10px","padding":"20px","background":"#F4FBF7","transition":"transform 0.2s"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"h3","attrs":{"style":{"color":"#6F82FB","marginTop":"0"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Customer API"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Customer portal endpoints for order tracking, status monitoring, and customer-facing operations."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"textAlign":"center","marginTop":"15px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://api-docs.qargo.com/customer/docs","style":{"display":"inline-block","background":"#6F82FB","color":"white","padding":"12px 24px","textDecoration":"none","borderRadius":"6px","fontWeight":"bold","transition":"background 0.3s"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Customer Documentation"},"children":[]}]}]}]}]}]}],"sectionId":"/docs/section/overview/documentation-for-other-parties"}],"sectionId":"/docs/section/overview/documentation-for-other-parties"},{"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 api requires oauth2 authentication with client id/secret. This should only be used for service to service communication."},"children":[]}]}]}]}],"sectionId":"/docs/section/authentication"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authentication/creating-application-credentials"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creating application credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application client credentials can be created by users with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Super admin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" role in the Qargo application."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Users can create and remove application clients by navigating to Configuration -> Organisation Settings (API clients sections)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applications need to be linked to a valid integration id, identifying the Qargo approved integrator."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please contact "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"mailto:integrations@qargo.com"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"us"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you don't have an id yet."},"children":[]}]}]}]}],"sectionId":"/docs/section/authentication/creating-application-credentials"}],"sectionId":"/docs/section/authentication/creating-application-credentials"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authentication/obtaining-an-access-token"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtaining an access token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To interact with the API, you need a valid access token in JWT (JSON Web Token) format. This token authenticates your requests and authorizes access to protected endpoints. The process involves using Basic Authentication to request the token via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/auth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"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":"link","inline":true,"attributes":{"href":"/docs/section/authentication/the-api-call-to-request-tokens"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/auth/token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be used to generate an access token (JWT):"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This token will need to be refreshed after expiration (we provide the 'expires_in' in the token response to check validity)."},"children":[]}]}]}]}],"sectionId":"/docs/section/authentication/obtaining-an-access-token"}],"sectionId":"/docs/section/authentication/obtaining-an-access-token"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/authentication/understanding-basic-authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Understanding Basic Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Basic Authentication is a simple HTTP authentication scheme that allows clients to provide credentials (such as a client ID and secret) directly in the request header. It works by encoding the credentials in Base64 and including them in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of the HTTP request. For example:"},"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":"Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Basic <base64-encoded-credentials>"},"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":"Credentials Encoding"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The client ID and secret are concatenated with a colon (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id:secret_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and then Base64-encoded."},"children":[]}]}]}]}]}],"sectionId":"/docs/section/authentication/understanding-basic-authentication"}],"sectionId":"/docs/section/authentication/understanding-basic-authentication"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/authentication/the-api-call-to-request-tokens"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API Call to Request Tokens"},"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":"/auth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint is a POST request used to generate a JWT access token. You authenticate this request using Basic Auth with your provided "},"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":"secret_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/docs/section/authentication/the-api-call-to-request-tokens"}],"sectionId":"/docs/section/authentication/the-api-call-to-request-tokens"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"section/authentication/request-details"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request Details"},"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":"Method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": POST"},"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":"URL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.qargo.com/v1/auth/token"},"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":"Headers"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"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":"code","inline":true,"attributes":{"content":"Content-Type: application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Basic <base64-encoded-client_id:secret_id>"},"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":"Body"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Empty."},"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":"Parameters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": None."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -XPOST https://api.qargo.com/v1/auth/token -H 'Content-type: application/json' -u '<client_id:secret_id>'\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -XPOST https://api.qargo.com/v1/auth/token -H 'Content-type: application/json' -u '<client_id:secret_id>'\n"},"children":[]}]}]}],"sectionId":"/docs/section/authentication/request-details"}],"sectionId":"/docs/section/authentication/request-details"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authentication/webhook-authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","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":"Important:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Webhook endpoints use a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"different authentication method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" than regular API endpoints. Do not use OAuth tokens for webhooks."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Qargo webhooks, such as those for order import and status updates, use "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Basic Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead of OAuth. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#understanding-basic-authentication"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Understanding Basic Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details on the Basic Auth scheme."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook credentials (client id and secret id) are "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"provisioned by Qargo"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when your webhook integration is configured — contact "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"mailto:integrations@qargo.com"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integrations@qargo.com"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to obtain them. They are "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"separate from your API credentials"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and must be used exclusively for webhook endpoints."},"children":[]}]}]}]}],"sectionId":"/docs/section/authentication/webhook-authentication"}],"sectionId":"/docs/section/authentication/webhook-authentication"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/authentication/api-vs-webhook-authentication-summary"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API vs Webhook authentication summary"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"th","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":"API endpoints"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"th","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":"Webhook endpoints"},"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":"Auth method"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth2 (Client Credentials)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Basic Authentication"},"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":"Credentials"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API client_id + secret_id → Bearer JWT token"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook client_id + secret_id (directly in header)"},"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":"Header format"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <jwt_token>"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Basic <base64(client_id:secret_id)>"},"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":"Where to find credentials"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configuration → Organisation Settings → API clients"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provisioned by Qargo — contact "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"mailto:integrations@qargo.com"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integrations@qargo.com"},"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":"Token refresh needed?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes (JWT expires)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No (credentials sent with each request)"},"children":[]}]}]}]}]}]}]}],"sectionId":"/docs/section/authentication/api-vs-webhook-authentication-summary"}],"sectionId":"/docs/section/authentication/api-vs-webhook-authentication-summary"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/authentication/common-mistake"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common mistake"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook credentials can technically be used to obtain an OAuth token via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/auth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint, but this token "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will not work"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for authenticating webhook requests. Always use Basic Authentication with your webhook credentials directly in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}]}],"sectionId":"/docs/section/authentication/common-mistake"}],"sectionId":"/docs/section/authentication/common-mistake"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/authentication/example-webhook-request"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example webhook request"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -XPOST https://api.qargo.com/v1/webhook/order-import \\\n  -H 'Content-Type: application/json' \\\n  -u '<webhook_client_id>:<webhook_secret_id>' \\\n  -d '{ ... }'\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -XPOST https://api.qargo.com/v1/webhook/order-import \\\n  -H 'Content-Type: application/json' \\\n  -u '<webhook_client_id>:<webhook_secret_id>' \\\n  -d '{ ... }'\n"},"children":[]}]}]}],"sectionId":"/docs/section/authentication/example-webhook-request"}],"sectionId":"/docs/section/authentication/example-webhook-request"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/rate-limits"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate Limits"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To maintain API stability and prevent abuse, we enforce rate limits on a per-tenant basis."},"children":[]}]}]}]}],"sectionId":"/docs/section/rate-limits"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/rate-limits/limits"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limits"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The limits below are estimates based on normal operating conditions. Under increased system load, these limits may be tightened without prior notice to protect API stability."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","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":"Category"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"th","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":"Scope"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"th","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":"Limit"},"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":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/auth/token"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5 requests per hour"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"General API Usage"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All endpoints "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"except"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authentication and webhooks"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2 requests per second (sustained); up to 3 per second (bursts)"},"children":[]}]}]}]}]}]}]}],"sectionId":"/docs/section/rate-limits/limits"}],"sectionId":"/docs/section/rate-limits/limits"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/rate-limits/enforcement"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enforcement"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limits are enforced by tracking requests over several sliding time windows-per second, per 10 minutes, and per hour. Exceeding any of these limits will result in an HTTP "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429 Too Many Requests"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response. The response includes a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header specifying the number of seconds your application should wait before making a new request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"image","inline":true,"attributes":{"alt":"Timeline showing how to pace API requests, wait with jitter after a 429 response, and retry successfully","src":"https://api.qargo.com/docs/static/rate_limit_timeline.svg"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example response:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"HTTP/1.1 429 Too Many Requests\nContent-Type: application/json\nRetry-After: 58\n\n{\"error\":\"Rate limit exceeded\"}\n","language":"http"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"HTTP/1.1 429 Too Many Requests\nContent-Type: application/json\nRetry-After: 58\n\n{\"error\":\"Rate limit exceeded\"}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applications must handle this response correctly by treating "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as the minimum delay, regardless of whether the request appeared to be within the estimated limits. If multiple workers or processes can make requests for the same tenant, add a small positive random delay (jitter) after "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before retrying. Never subtract jitter or retry earlier than indicated. If another "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response is returned, repeat this process using the latest "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For any concerns about these limits, please contact us at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"mailto:integrations@qargo.com"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integrations@qargo.com"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/docs/section/rate-limits/enforcement"}],"sectionId":"/docs/section/rate-limits/enforcement"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/api-best-practices"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Best Practices"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This section outlines recommended practices for efficiently working with the Qargo API."},"children":[]}]}]}]}],"sectionId":"/docs/section/api-best-practices"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/api-best-practices/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":"Some list endpoints support cursor-based pagination. Paginated responses contain "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", pass its value unchanged as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter in the next request. Do not combine "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with other query parameters."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]}]}],"sectionId":"/docs/section/api-best-practices/pagination"}],"sectionId":"/docs/section/api-best-practices/pagination"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/api-best-practices/how-pagination-works"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How pagination works"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initial request"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Make a request to a paginated endpoint without a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"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":"Process the response"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Read the current page from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"items"},"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":"Subsequent requests"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", pass its value as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter in the next request."},"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":"Stop"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Repeat until "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]}]}],"sectionId":"/docs/section/api-best-practices/how-pagination-works"}],"sectionId":"/docs/section/api-best-practices/how-pagination-works"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/api-best-practices/example-usage"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example usage"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"GET /v1/resources/resource\n","language":"http"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET /v1/resources/resource\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"items\": [\n    {\n      \"name\": \"Truck 142\",\n      \"row_id\": \"3f9e6b1c-3333-4d2e-b1a4-7c8f9e0a1b03\"\n    }\n  ],\n  \"next_cursor\": \"eyJwYXJhbWV0ZXJzIjp7fSwic3RhdGUiOiJhYmMxMjM0NSIsImN1cnNvcl9zb3J0IjoiMjAyNi0wOC0xMlQxMDowMDowMFoiLCJjdXJzb3JfaWQiOiIzZjllNmIxYy0zMzMzLTRkMmUtYjFhNC03YzhmOWUwYTFiMDMifQ==\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"items\": [\n    {\n      \"name\": \"Truck 142\",\n      \"row_id\": \"3f9e6b1c-3333-4d2e-b1a4-7c8f9e0a1b03\"\n    }\n  ],\n  \"next_cursor\": \"eyJwYXJhbWV0ZXJzIjp7fSwic3RhdGUiOiJhYmMxMjM0NSIsImN1cnNvcl9zb3J0IjoiMjAyNi0wOC0xMlQxMDowMDowMFoiLCJjdXJzb3JfaWQiOiIzZjllNmIxYy0zMzMzLTRkMmUtYjFhNC03YzhmOWUwYTFiMDMifQ==\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Next request:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"GET /v1/resources/resource?cursor=eyJwYXJhbWV0ZXJzIjp7fSwic3RhdGUiOiJhYmMxMjM0NSIsImN1cnNvcl9zb3J0IjoiMjAyNi0wOC0xMlQxMDowMDowMFoiLCJjdXJzb3JfaWQiOiIzZjllNmIxYy0zMzMzLTRkMmUtYjFhNC03YzhmOWUwYTFiMDMifQ==\n","language":"http"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET /v1/resources/resource?cursor=eyJwYXJhbWV0ZXJzIjp7fSwic3RhdGUiOiJhYmMxMjM0NSIsImN1cnNvcl9zb3J0IjoiMjAyNi0wOC0xMlQxMDowMDowMFoiLCJjdXJzb3JfaWQiOiIzZjllNmIxYy0zMzMzLTRkMmUtYjFhNC03YzhmOWUwYTFiMDMifQ==\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The next page can be empty. Continue until the response returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/docs/section/api-best-practices/example-usage"}],"sectionId":"/docs/section/api-best-practices/example-usage"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/api-best-practices/recommendations"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recommendations"},"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":"Check that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before making another request."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Treat cursors as opaque. Do not parse, modify, or construct them."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do not combine "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with other query parameters."},"children":[]}]}]}]}]}],"sectionId":"/docs/section/api-best-practices/recommendations"}],"sectionId":"/docs/section/api-best-practices/recommendations"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/api-best-practices/backward-compatibility"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Backward compatibility"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Qargo API follows these backward compatibility principles:"},"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":"New fields may be added"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to response payloads at any time. Adding new fields is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" considered a breaking change."},"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":"Integrators should ignore unknown fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when parsing responses. Do not fail on unexpected properties."},"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":"Deprecated fields and endpoints"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are marked as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deprecated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in this specification. They continue to work but may be removed in a future version. Migrate to the recommended replacement as soon as possible."},"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":"Existing fields will not be renamed or removed"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" without prior notice and a deprecation period."},"children":[]}]}]}]}]}],"sectionId":"/docs/section/api-best-practices/backward-compatibility"}],"sectionId":"/docs/section/api-best-practices/backward-compatibility"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/api-best-practices/date-and-time-formats"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time formats"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All date and time fields in the API follow ISO 8601:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"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":"text","inline":true,"attributes":{"content":"Date"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2024-12-31"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Calendar date without time component"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Datetime"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DDTHH:mm:ssZ"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2024-12-31T14:30:00Z"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp in UTC (indicated by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" suffix)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HH:mm"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"09:30"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time of day in 24-hour format"},"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":"Datetime fields are always in UTC."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Convert to local time on the client side."},"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":"Date fields have no timezone."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" They represent a calendar date (e.g. a planned delivery date)."},"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":"Time fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are used for time windows (e.g. delivery windows) and are in 24-hour format without seconds."},"children":[]}]}]}]}]}],"sectionId":"/docs/section/api-best-practices/date-and-time-formats"}],"sectionId":"/docs/section/api-best-practices/date-and-time-formats"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/concepts"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concepts"},"children":[]}]}]}]}],"sectionId":"/docs/section/concepts"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/concepts/company"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A company in Qargo can be both a customer as well as a subcontractor (supplier)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The entity will have a single id within Qargo. The api client can link companies by this id,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or by the accounting code, which is a user defined code field."},"children":[]}]}]}]}],"sectionId":"/docs/section/concepts/company"}],"sectionId":"/docs/section/concepts/company"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/concepts/order"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transport order to execute. Also called job in other TMS systems. It contains all transport details:"},"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":"Order references"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/section/concepts/company"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"company"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Consigments, with their "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/section/concepts/stop"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"stop"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" locations, time windows, references"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Definition of the goods to transport"},"children":[]}]}]}]}]}],"sectionId":"/docs/section/concepts/order"}],"sectionId":"/docs/section/concepts/order"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/concepts/stop"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stop"},"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":"A stop is a part of a transport, at a certain date, optional timeslot and location."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In addition to the planned times, it also tracks the actual times for a completed stop."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stops can be linked to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/section/concepts/order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or can be defined standalone (for example a cleaning stop)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All stops are linked to a Trip."},"children":[]}]}]}]}]}],"sectionId":"/docs/section/concepts/stop"}],"sectionId":"/docs/section/concepts/stop"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/concepts/stop-group"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stop group"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stops can be grouped together according to their activity and location. This is called a stop group."},"children":[]}]}]}]}],"sectionId":"/docs/section/concepts/stop-group"}],"sectionId":"/docs/section/concepts/stop-group"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/concepts/trip"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trip"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A trip contains "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/section/concepts/stop"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"stops"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from various "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/section/concepts/order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or standalone "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/section/concepts/stop"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"stops"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It tracks how a certain"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transport is planned, and who will execute that transport."},"children":[]}]}]}]}],"sectionId":"/docs/section/concepts/trip"}],"sectionId":"/docs/section/concepts/trip"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/concepts/task"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Task"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A task is the primary workflow concept in Qargo. Users can define their own flow,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"using both built-in tasks as well a custom defined ones. For the current accounting use case,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"we only expose the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"post invoice/credit note"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" task, that allows users to send invoices to an accounting system."},"children":[]}]}]}]}],"sectionId":"/docs/section/concepts/task"}],"sectionId":"/docs/section/concepts/task"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/concepts/resource"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A resource in Qargo is a vehicle, driver, trailer or other entity that can be assigned to a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/section/concepts/trip"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"trip"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/docs/section/concepts/resource"}],"sectionId":"/docs/section/concepts/resource"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/concepts/unavailability"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unavailability"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unavailability indicates that a specific "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/section/concepts/resource"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"resource"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not available for use for a given time range. An unavailability has a reason to indicate why the resource is not available."},"children":[]}]}]}]}],"sectionId":"/docs/section/concepts/unavailability"}],"sectionId":"/docs/section/concepts/unavailability"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/concepts/status-update"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status update"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A status update reflects a status change in an entity."},"children":[]}]}]}]}],"sectionId":"/docs/section/concepts/status-update"}],"sectionId":"/docs/section/concepts/status-update"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/concepts/document"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A document in Qargo can be identified by a unique id. It has a type and is linked to a certain entity (for example an order)."},"children":[]}]}]}]}],"sectionId":"/docs/section/concepts/document"}],"sectionId":"/docs/section/concepts/document"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/postman-collection"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Postman collection"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We have a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.postman.com/downloads/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"postman"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" collection "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/postman.json","title":"download"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"available"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with interactive examples (right click to download). Download this to a local folder, and import it into Postman for usage."},"children":[]}]}]}]}],"sectionId":"/docs/section/postman-collection"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/postman-collection/instructions"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Instructions"},"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":"Make sure you have a Postman client available. This can either be a local installed version or the web based version."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request credentials for the Qargo API for order creation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Download and import the collection"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set the collection variables username and password with the credentials received"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execute the Request Access token request in the Authentication folder. You have now a valid access key for 1 hour. If you get the error message that the key is no longer valid, please refresh the access key by invoking this endpoint again."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can now explore the different order endpoints"},"children":[]}]}]}]}]}],"sectionId":"/docs/section/postman-collection/instructions"}],"sectionId":"/docs/section/postman-collection/instructions"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/functionality"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Functionality"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The api exposes the following functionality:"},"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":"Order management: create/update and get the status of transport orders."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve trip information: retrieve information about Qargo "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/section/concepts/trip"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"trips"},"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":"Visibility: send events to an external system using webhooks."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order dispatch: send transport orders to a 3rd party using webhooks."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accounting: interface an accounting system using the api endpoints."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Documents: interface to download documents"},"children":[]}]}]}]}]}],"sectionId":"/docs/section/functionality"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/functionality/order-management"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order management"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available functionality:"},"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 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/section/concepts/order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in Qargo and track order status."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Export any existing order to be used as a template for future order creation."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The api reference is available here: "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order api"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/docs/section/functionality/order-management"}],"sectionId":"/docs/section/functionality/order-management"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/functionality/trip-information"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trip information"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/section/concepts/trip"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trips"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can't be manipulated yet through the api, but it is possible to retrieve trip information."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We currently have an endpoint available to retrieve the charge information for a certain endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update the status of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/section/concepts/stop"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"stops"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/section/concepts/stop"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"stop groups"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of a trip using a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/webhooks-inbound/subcontractor-status-update-webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/docs/section/functionality/trip-information"}],"sectionId":"/docs/section/functionality/trip-information"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/functionality/resource-management"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource management"},"children":[]}]}]}]}],"sectionId":"/docs/section/functionality/resource-management"}],"sectionId":"/docs/section/functionality/resource-management"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/functionality/resource"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/section/concepts/resource"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resources"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" this should be used together with the endpoints to fetch unavailabilities as a resource unavailability is linked to a resource."},"children":[]}]}]}]}],"sectionId":"/docs/section/functionality/resource"}],"sectionId":"/docs/section/functionality/resource"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/functionality/unavailability"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unavailability"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/section/concepts/unavailability"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource unavailabilities"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be managed through the API. The following operations are supported:"},"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":"Creating an unavailability for a resource"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updating an unavailability for a resource"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deleting an unavailability for a resource"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetching an unavailability for a resource"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetching all unavailabilities for a resource"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The goal of these endpoints is to allow external systems to manage the availability of resources in Qargo. An "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is stored alongside the unavailability to allow for easy linking between the external system and Qargo. This "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" should be provided if a referential link is needed between the external system and Qargo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/section/resources/unavailabilities"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"examples"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on how to use the unavailability endpoints."},"children":[]}]}]}]}],"sectionId":"/docs/section/functionality/unavailability"}],"sectionId":"/docs/section/functionality/unavailability"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/functionality/visibility"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visibility"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We support visibility (sending messages triggered by Qargo system events) in the api as well."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These messages can be send out as a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/webhooks-outbound/operational_visibility_event_webhook_post"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or an EDI connection."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For most endpoints, visibility only trigger on status changes (for example, from stop "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN_PROGRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" -> "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are a few exceptions, these will be indicated in the overview:"},"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":"Order level"},"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":"We send out a visibility event on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCEPTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (order created), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REJECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (order skipped) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (all stops for order completed)."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stop level"},"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":"We send out a visibility event on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AT_STOP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (arrived at stop), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (all activities completed for stop)."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Position level (note: for every telematics update)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trip level"},"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":"We send a visibility event when a trip changes to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PLANNED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and when it transitions to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"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":"Resource level"},"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":"We send an event when a resource is assigned to a certain "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/section/concepts/trip"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"trip"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}]}],"sectionId":"/docs/section/functionality/visibility"}],"sectionId":"/docs/section/functionality/visibility"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/functionality/order-dispatch"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order dispatch"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is also possible to subcontract trips to other parties. This is possible using two push endpoints:"},"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":"Outgoing dispatched trip "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/webhooks-outbound/subcontractor-dispatch-payload"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payload"},"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":"Incoming "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/webhooks-inbound/subcontractor-status-update-webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"message format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to update subcontracted status."},"children":[]}]}]}]}]}],"sectionId":"/docs/section/functionality/order-dispatch"}],"sectionId":"/docs/section/functionality/order-dispatch"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/functionality/documents"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Documents"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We offer an interface to download documents. The documents can be fetched using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-document"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"document endpoints"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/docs/section/functionality/documents"}],"sectionId":"/docs/section/functionality/documents"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/functionality/request-additional-endpoints"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request additional endpoints"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please contact "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"mailto:integrations@qargo.com"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"us"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for inqueries regarding additional api functionality."},"children":[]}]}]}]}],"sectionId":"/docs/section/functionality/request-additional-endpoints"}],"sectionId":"/docs/section/functionality/request-additional-endpoints"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/transport-order-creation-and-status"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transport order creation & status"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This sections details how to construct payloads to create transport orders using the order upload endpoint("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-order/import_order_v1_orders_order_upload_post"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/orders/order/upload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"sectionId":"/docs/section/transport-order-creation-and-status"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/transport-order-creation-and-status/order-creation-metadata"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order creation metadata"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders are not created synchronously via the API. When creating orders via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /orders/order/upload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint, you will receive the following response when creating an order."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"upload_id\": \"<UPLOAD UUID>\",\n  \"upload_status\": \"IN_PROGRESS\",\n  \"upload_url\": \"v1/orders/order/upload/<UPLOAD UUID>\",\n  \"order_id\": null,\n  \"order_url\": null\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"upload_id\": \"<UPLOAD UUID>\",\n  \"upload_status\": \"IN_PROGRESS\",\n  \"upload_url\": \"v1/orders/order/upload/<UPLOAD UUID>\",\n  \"order_id\": null,\n  \"order_url\": null\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You need to store the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upload_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" so you can fetch the status of the order creation by calling "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /orders/order/upload/<UPLOAD UUID>"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Based on the status of the upload ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upload_status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), you can know if the order is still in the progress of being created or has already been created. Both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be filled in when the order has been created. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be filled in with the order id, which can then be used to fetch the order data and status from the system."},"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":"Example payload "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /orders/order/upload/e01b3db1-4e49-4241-a91e-7534da884d46"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a created order"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"upload_id\": \"e01b3db1-4e49-4241-a91e-7534da884d46\",\n  \"upload_status\": \"COMPLETED\",\n  \"upload_url\": \"v1/orders/order/upload/e01b3db1-4e49-4241-a91e-7534da884d46\",\n  \"order_id\": \"a2a84715-0027-49af-ad30-494c0ccf75cc\",\n  \"order_url\": \"v1/orders/order/a2a84715-0027-49af-ad30-494c0ccf75cc\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"upload_id\": \"e01b3db1-4e49-4241-a91e-7534da884d46\",\n  \"upload_status\": \"COMPLETED\",\n  \"upload_url\": \"v1/orders/order/upload/e01b3db1-4e49-4241-a91e-7534da884d46\",\n  \"order_id\": \"a2a84715-0027-49af-ad30-494c0ccf75cc\",\n  \"order_url\": \"v1/orders/order/a2a84715-0027-49af-ad30-494c0ccf75cc\"\n}\n"},"children":[]}]}]}],"sectionId":"/docs/section/transport-order-creation-and-status/order-creation-metadata"}],"sectionId":"/docs/section/transport-order-creation-and-status/order-creation-metadata"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/transport-order-creation-and-status/order-identifier"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order identifier"},"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":"order_identifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used to uniquely identify orders that are being created via the API. This means that the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order_identifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" needs to be used when updating orders. Multiple identical updates after each other are idempotent and will not fail the request."},"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":"order_identifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" main usage is for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deduplication"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you cannot use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order_identifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to fetch an order."},"children":[]}]}]}]}],"sectionId":"/docs/section/transport-order-creation-and-status/order-identifier"}],"sectionId":"/docs/section/transport-order-creation-and-status/order-identifier"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/transport-order-creation-and-status/create-an-order"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an order"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The first example is a simple transport from our london office to our Ghent office."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note that the transport service will need to be matched with the one in your system."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"operation\": \"CREATE\",\n  \"consignments\": [\n    {\n      \"delivery_stop\": {\n        \"date\": \"2022-05-03\",\n        \"location\": {\n          \"name\": \"Qargo Ghent office\",\n          \"address\": \"Gaston Crommenlaan 4\",\n          \"postal_code\": \"9050\",\n          \"city\": \"Ghent\",\n          \"country\": \"BE\"\n        },\n        \"reference_number\": \"D12345\"\n      },\n      \"pickup_stop\": {\n        \"date\": \"2022-04-21\",\n        \"location\": {\n          \"name\": \"Qargo London office\",\n          \"address\": \"71-91 Aldwych\",\n          \"postal_code\": \"WC2B 4HN\",\n          \"city\": \"London\",\n          \"country\": \"UK\"\n        },\n        \"reference_number\": \"P123456\"\n      }\n    }\n  ],\n  \"customer_reference_number\": \"T12345\",\n  \"customer\": {\n    \"code\": \"00020\"\n  },\n  \"order_identifier\": \"T1234393\",\n  \"transport_service\": {\n    \"name\": \"General\"\n  }\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"operation\": \"CREATE\",\n  \"consignments\": [\n    {\n      \"delivery_stop\": {\n        \"date\": \"2022-05-03\",\n        \"location\": {\n          \"name\": \"Qargo Ghent office\",\n          \"address\": \"Gaston Crommenlaan 4\",\n          \"postal_code\": \"9050\",\n          \"city\": \"Ghent\",\n          \"country\": \"BE\"\n        },\n        \"reference_number\": \"D12345\"\n      },\n      \"pickup_stop\": {\n        \"date\": \"2022-04-21\",\n        \"location\": {\n          \"name\": \"Qargo London office\",\n          \"address\": \"71-91 Aldwych\",\n          \"postal_code\": \"WC2B 4HN\",\n          \"city\": \"London\",\n          \"country\": \"UK\"\n        },\n        \"reference_number\": \"P123456\"\n      }\n    }\n  ],\n  \"customer_reference_number\": \"T12345\",\n  \"customer\": {\n    \"code\": \"00020\"\n  },\n  \"order_identifier\": \"T1234393\",\n  \"transport_service\": {\n    \"name\": \"General\"\n  }\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: it is possible to 'export' existing orders in the api to use as examples/templates."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/section/transport-order-creation-and-status/export-an-existing-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Export existing orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section."},"children":[]}]}]}]}],"sectionId":"/docs/section/transport-order-creation-and-status/create-an-order"}],"sectionId":"/docs/section/transport-order-creation-and-status/create-an-order"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/transport-order-creation-and-status/update-an-order"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update an order"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following order is an update of an existing order. Note the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UPDATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value of the operation field."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important remarks:"},"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":"Not all the fields of the order can be updated"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"order_identifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is used to identify the order to update"},"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":"Example of an order update"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"order_identifier\": \"QARGO_TEST_0001\",\n  \"operation\": \"UPDATE\",\n  \"customer\": {\n    \"name\": \"UPS SCS Coventry\"\n  },\n  \"consignments\": [\n    {\n      \"pickup_stop\": {\n        \"location\": {\n          \"name\": \"Qargo HQ\",\n          \"address\": \"Gaston Crommenlaan 4,\",\n          \"postal_code\": \"9000\",\n          \"city\": \"Gent\",\n          \"state\": \"Oost-Vlaanderen\",\n          \"country\": \"BE\",\n          \"description\": \"Qargo HQ building\"\n        },\n        \"note\": \"Pickup 4 boxes of pasta\",\n        \"date\": \"2024-08-20\",\n        \"reference_number\": \"QACOLLI001\",\n        \"planning_instructions\": \"If closed, call mobile number\",\n        \"email\": \"info@qargo.com\",\n        \"phone_number\": \"+0912341431\",\n        \"mobile_number\": \"+324567890\"\n      },\n      \"delivery_stop\": {\n        \"location\": {\n          \"name\": \"Grocery store\",\n          \"address\": \"Resedastraat 20\",\n          \"postal_code\": \"9000\",\n          \"city\": \"Gent\",\n          \"state\": \"Oost-Vlaanderen\",\n          \"country\": \"BE\",\n          \"description\": \"Grocery store\"\n        },\n        \"note\": \"Don't forget to sign the documents\",\n        \"date\": \"2024-08-21\",\n        \"reference_number\": \"QADELIV001\",\n        \"planning_instructions\": \"Alarm code: 123456\",\n        \"email\": \"info@qargo.com\",\n        \"phone_number\": \"02123456\",\n        \"mobile_number\": \"+329998888\"\n      },\n      \"goods\": [\n        {\n          \"description\": \"4 boxes of pasta\",\n          \"quantity\": 4\n        }\n      ]\n    }\n  ],\n  \"customer_reference_number\": \"QARGO_TEST_0001\",\n  \"transport_service\": {\n    \"code\": \"CONTAINER_BOOKING\"\n  }\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"order_identifier\": \"QARGO_TEST_0001\",\n  \"operation\": \"UPDATE\",\n  \"customer\": {\n    \"name\": \"UPS SCS Coventry\"\n  },\n  \"consignments\": [\n    {\n      \"pickup_stop\": {\n        \"location\": {\n          \"name\": \"Qargo HQ\",\n          \"address\": \"Gaston Crommenlaan 4,\",\n          \"postal_code\": \"9000\",\n          \"city\": \"Gent\",\n          \"state\": \"Oost-Vlaanderen\",\n          \"country\": \"BE\",\n          \"description\": \"Qargo HQ building\"\n        },\n        \"note\": \"Pickup 4 boxes of pasta\",\n        \"date\": \"2024-08-20\",\n        \"reference_number\": \"QACOLLI001\",\n        \"planning_instructions\": \"If closed, call mobile number\",\n        \"email\": \"info@qargo.com\",\n        \"phone_number\": \"+0912341431\",\n        \"mobile_number\": \"+324567890\"\n      },\n      \"delivery_stop\": {\n        \"location\": {\n          \"name\": \"Grocery store\",\n          \"address\": \"Resedastraat 20\",\n          \"postal_code\": \"9000\",\n          \"city\": \"Gent\",\n          \"state\": \"Oost-Vlaanderen\",\n          \"country\": \"BE\",\n          \"description\": \"Grocery store\"\n        },\n        \"note\": \"Don't forget to sign the documents\",\n        \"date\": \"2024-08-21\",\n        \"reference_number\": \"QADELIV001\",\n        \"planning_instructions\": \"Alarm code: 123456\",\n        \"email\": \"info@qargo.com\",\n        \"phone_number\": \"02123456\",\n        \"mobile_number\": \"+329998888\"\n      },\n      \"goods\": [\n        {\n          \"description\": \"4 boxes of pasta\",\n          \"quantity\": 4\n        }\n      ]\n    }\n  ],\n  \"customer_reference_number\": \"QARGO_TEST_0001\",\n  \"transport_service\": {\n    \"code\": \"CONTAINER_BOOKING\"\n  }\n}\n"},"children":[]}]}]}],"sectionId":"/docs/section/transport-order-creation-and-status/update-an-order"}],"sectionId":"/docs/section/transport-order-creation-and-status/update-an-order"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/transport-order-creation-and-status/cancel-an-order"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancel an order"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To cancel an order, pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"operation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value. This will cancel the order. If the order has already been cancelled, this will not result in an error. Executing multiple cancellations is a idempotent operation and will not fail the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cancelled order cannot be uncancelled. If you need to revert the cancel, you will need to recreate the original order "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"using a different order identifier"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Using the same order identifier will cause the system to try to update the cancelled order, which results in an error."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"operation\": \"DELETE\",\n  \"consignments\": [\n    {\n      \"delivery_stop\": {\n        \"date\": \"2022-05-03\",\n        \"location\": {\n          \"name\": \"Qargo Ghent office\",\n          \"address\": \"Gaston Crommenlaan 4\",\n          \"postal_code\": \"9050\",\n          \"city\": \"Ghent\",\n          \"country\": \"BE\"\n        },\n        \"reference_number\": \"D12345\"\n      },\n      \"pickup_stop\": {\n        \"date\": \"2022-04-21\",\n        \"location\": {\n          \"name\": \"Qargo London office\",\n          \"address\": \"71-91 Aldwych\",\n          \"postal_code\": \"WC2B 4HN\",\n          \"city\": \"London\",\n          \"country\": \"UK\"\n        },\n        \"reference_number\": \"P123456\"\n      }\n    }\n  ],\n  \"customer_reference_number\": \"T12345\",\n  \"customer\": {\n    \"code\": \"00020\"\n  },\n  \"order_identifier\": \"T1234393\",\n  \"transport_service\": {\n    \"name\": \"General\"\n  }\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"operation\": \"DELETE\",\n  \"consignments\": [\n    {\n      \"delivery_stop\": {\n        \"date\": \"2022-05-03\",\n        \"location\": {\n          \"name\": \"Qargo Ghent office\",\n          \"address\": \"Gaston Crommenlaan 4\",\n          \"postal_code\": \"9050\",\n          \"city\": \"Ghent\",\n          \"country\": \"BE\"\n        },\n        \"reference_number\": \"D12345\"\n      },\n      \"pickup_stop\": {\n        \"date\": \"2022-04-21\",\n        \"location\": {\n          \"name\": \"Qargo London office\",\n          \"address\": \"71-91 Aldwych\",\n          \"postal_code\": \"WC2B 4HN\",\n          \"city\": \"London\",\n          \"country\": \"UK\"\n        },\n        \"reference_number\": \"P123456\"\n      }\n    }\n  ],\n  \"customer_reference_number\": \"T12345\",\n  \"customer\": {\n    \"code\": \"00020\"\n  },\n  \"order_identifier\": \"T1234393\",\n  \"transport_service\": {\n    \"name\": \"General\"\n  }\n}\n"},"children":[]}]}]}],"sectionId":"/docs/section/transport-order-creation-and-status/cancel-an-order"}],"sectionId":"/docs/section/transport-order-creation-and-status/cancel-an-order"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/transport-order-creation-and-status/export-an-existing-order"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Export an existing order"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is possible to export a manually created order in the api. We first need to determine the technical id of this order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"image","inline":true,"attributes":{"alt":"Retrieve order id","src":"https://api.qargo.com/docs/static/order_id.png"},"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":"The order can be exported with the following endpoint:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/section/transport-order-creation-and-status/export-an-existing-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Export order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The output of this endpoint corresponds to the order creation format. Just make sure to use a different "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/section/transport-order-creation-and-status/order-identifier"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order_identifier"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", otherwise the 'new' order will be interpreted as an update."},"children":[]}]}]}]}],"sectionId":"/docs/section/transport-order-creation-and-status/export-an-existing-order"}],"sectionId":"/docs/section/transport-order-creation-and-status/export-an-existing-order"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/transport-order-creation-and-status/fetch-order-data-and-status"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetch order data and status"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /orders/order/<ORDER UUID>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-order/get_order_details_v1_orders_order__order_id__get"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you can fetch the data related to the order. This contains the current "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the order along with other data."},"children":[]}]}]}]}],"sectionId":"/docs/section/transport-order-creation-and-status/fetch-order-data-and-status"}],"sectionId":"/docs/section/transport-order-creation-and-status/fetch-order-data-and-status"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/transport-order-creation-and-status/container-orders"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container orders"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are 2 types of container orders that can be created using the API, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IMPORT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXPORT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/docs/section/transport-order-creation-and-status/container-orders"}],"sectionId":"/docs/section/transport-order-creation-and-status/container-orders"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/transport-order-creation-and-status/import"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Import"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This scenario contains of 2 main stops additional optional stops."},"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":"Pickup of a loaded container"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unload container"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Drop off empty container (Optional, configured in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"teardown_stops"},"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":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"container_scenario"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IMPORT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the drop off location of the container is specified in the the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"teardown_stops"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property. The optional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"teardown_stops"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" describe the stops of the container after the consignment has been completed"},"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":"Example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IMPORT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" container scenario"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"order_identifier\": \"QARGO_TEST_0002\",\n  \"operation\": \"CREATE\",\n  \"customer\": {\n    \"name\": \"UPS SCS Coventry\"\n  },\n  \"teardown_stops\": [\n    {\n      \"location\": {\n        \"name\": \"Container yard\",\n        \"address\": \"Scheepzatestraat 1\",\n        \"postal_code\": \"9000\",\n        \"city\": \"Gent\",\n        \"state\": \"Oost-Vlaanderen\",\n        \"country\": \"BE\"\n      },\n      \"note\": \"Drop off the container on the designated location\",\n      \"date\": \"2024-08-20\",\n      \"reference_number\": \"CONT0001\",\n      \"planning_instructions\": \"Put next to the red container\",\n      \"email\": \"info@qargo.com\",\n      \"phone_number\": \"+0912341431\",\n      \"mobile_number\": \"+324567890\"\n    }\n  ],\n  \"consignments\": [\n    {\n      \"pickup_stop\": {\n        \"location\": {\n          \"name\": \"Container pickup location\",\n          \"address\": \"Gaston Crommenlaan 4,\",\n          \"postal_code\": \"9000\",\n          \"city\": \"Gent\",\n          \"state\": \"Oost-Vlaanderen\",\n          \"country\": \"BE\",\n          \"description\": \"This is the container pickup location\"\n        },\n        \"note\": \"Pick up the green container\",\n        \"date\": \"2024-08-20\",\n        \"reference_number\": \"CONT0002\",\n        \"planning_instructions\": \"Code of the container is 1234\",\n        \"email\": \"info@qargo.com\",\n        \"phone_number\": \"+0912341431\",\n        \"mobile_number\": \"+324567890\"\n      },\n      \"delivery_stop\": {\n        \"location\": {\n          \"name\": \"Sports store\",\n          \"address\": \"Resedastraat 20\",\n          \"postal_code\": \"9000\",\n          \"city\": \"Gent\",\n          \"state\": \"Oost-Vlaanderen\",\n          \"country\": \"BE\",\n          \"description\": \"This is the delivery location of the container goods\"\n        },\n        \"note\": \"1000 boxes of shoes\",\n        \"date\": \"2024-08-21\",\n        \"reference_number\": \"CONT0003\",\n        \"planning_instructions\": \"Use mobile number if gate is closed\",\n        \"email\": \"info@qargo.com\",\n        \"phone_number\": \"02123456\",\n        \"mobile_number\": \"+329998888\"\n      }\n    }\n  ],\n  \"container\": {\n    \"container_scenario\": \"IMPORT\"\n  },\n  \"customer_reference_number\": \"QARGO_TEST_0002\",\n  \"transport_service\": {\n    \"code\": \"CONTAINERS\"\n  }\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"order_identifier\": \"QARGO_TEST_0002\",\n  \"operation\": \"CREATE\",\n  \"customer\": {\n    \"name\": \"UPS SCS Coventry\"\n  },\n  \"teardown_stops\": [\n    {\n      \"location\": {\n        \"name\": \"Container yard\",\n        \"address\": \"Scheepzatestraat 1\",\n        \"postal_code\": \"9000\",\n        \"city\": \"Gent\",\n        \"state\": \"Oost-Vlaanderen\",\n        \"country\": \"BE\"\n      },\n      \"note\": \"Drop off the container on the designated location\",\n      \"date\": \"2024-08-20\",\n      \"reference_number\": \"CONT0001\",\n      \"planning_instructions\": \"Put next to the red container\",\n      \"email\": \"info@qargo.com\",\n      \"phone_number\": \"+0912341431\",\n      \"mobile_number\": \"+324567890\"\n    }\n  ],\n  \"consignments\": [\n    {\n      \"pickup_stop\": {\n        \"location\": {\n          \"name\": \"Container pickup location\",\n          \"address\": \"Gaston Crommenlaan 4,\",\n          \"postal_code\": \"9000\",\n          \"city\": \"Gent\",\n          \"state\": \"Oost-Vlaanderen\",\n          \"country\": \"BE\",\n          \"description\": \"This is the container pickup location\"\n        },\n        \"note\": \"Pick up the green container\",\n        \"date\": \"2024-08-20\",\n        \"reference_number\": \"CONT0002\",\n        \"planning_instructions\": \"Code of the container is 1234\",\n        \"email\": \"info@qargo.com\",\n        \"phone_number\": \"+0912341431\",\n        \"mobile_number\": \"+324567890\"\n      },\n      \"delivery_stop\": {\n        \"location\": {\n          \"name\": \"Sports store\",\n          \"address\": \"Resedastraat 20\",\n          \"postal_code\": \"9000\",\n          \"city\": \"Gent\",\n          \"state\": \"Oost-Vlaanderen\",\n          \"country\": \"BE\",\n          \"description\": \"This is the delivery location of the container goods\"\n        },\n        \"note\": \"1000 boxes of shoes\",\n        \"date\": \"2024-08-21\",\n        \"reference_number\": \"CONT0003\",\n        \"planning_instructions\": \"Use mobile number if gate is closed\",\n        \"email\": \"info@qargo.com\",\n        \"phone_number\": \"02123456\",\n        \"mobile_number\": \"+329998888\"\n      }\n    }\n  ],\n  \"container\": {\n    \"container_scenario\": \"IMPORT\"\n  },\n  \"customer_reference_number\": \"QARGO_TEST_0002\",\n  \"transport_service\": {\n    \"code\": \"CONTAINERS\"\n  }\n}\n"},"children":[]}]}]}],"sectionId":"/docs/section/transport-order-creation-and-status/import"}],"sectionId":"/docs/section/transport-order-creation-and-status/import"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/transport-order-creation-and-status/export"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Export"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This scenario contains 2 main stops with additional optional stops:"},"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":"Pickup empty container (Optional, configured in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"setup_stops"},"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":"Load empty container"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Drop off loaded container"},"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":"container_scenario"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXPORT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"setup_stops"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property allows to define additional optional stops."},"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":"Example of an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXPORT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"container_scenario"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"order_identifier\": \"QARGO_TEST_0003\",\n  \"operation\": \"CREATE\",\n  \"customer\": {\n    \"name\": \"UPS SCS Coventry\"\n  },\n  \"setup_stops\": [\n    {\n      \"location\": {\n        \"name\": \"Container yard\",\n        \"address\": \"Scheepzatestraat 1\",\n        \"postal_code\": \"9000\",\n        \"city\": \"Gent\",\n        \"state\": \"Oost-Vlaanderen\",\n        \"country\": \"BE\"\n      },\n      \"note\": \"Pickup empty container on the designated location\",\n      \"date\": \"2024-08-20\",\n      \"reference_number\": \"CONT0001\",\n      \"planning_instructions\": \"Blue container, next to the red container\",\n      \"email\": \"info@qargo.com\",\n      \"phone_number\": \"+0912341431\",\n      \"mobile_number\": \"+324567890\"\n    }\n  ],\n  \"consignments\": [\n    {\n      \"pickup_stop\": {\n        \"location\": {\n          \"name\": \"Container loading location\",\n          \"address\": \"Gaston Crommenlaan 4,\",\n          \"postal_code\": \"9000\",\n          \"city\": \"Gent\",\n          \"state\": \"Oost-Vlaanderen\",\n          \"country\": \"BE\",\n          \"description\": \"Qargo HQ, has a container loading bay\"\n        },\n        \"note\": \"Fill with 1000 boxes of Qargo shirts\",\n        \"date\": \"2024-08-20\",\n        \"reference_number\": \"CONT0002\",\n        \"planning_instructions\": \"Code of the container is 1234\",\n        \"email\": \"info@qargo.com\",\n        \"phone_number\": \"+0912341431\",\n        \"mobile_number\": \"+324567890\"\n      },\n      \"delivery_stop\": {\n        \"location\": {\n          \"name\": \"Train station container hub\",\n          \"address\": \"Resedastraat 20\",\n          \"postal_code\": \"9000\",\n          \"city\": \"Gent\",\n          \"state\": \"Oost-Vlaanderen\",\n          \"country\": \"BE\",\n          \"description\": \"This is the dropoff location of the loaded container\"\n        },\n        \"note\": \"1000 boxes of shoes\",\n        \"date\": \"2024-08-21\",\n        \"reference_number\": \"CONT0003\",\n        \"planning_instructions\": \"Use mobile number if gate is closed\",\n        \"email\": \"info@qargo.com\",\n        \"phone_number\": \"02123456\",\n        \"mobile_number\": \"+329998888\"\n      }\n    }\n  ],\n  \"container\": {\n    \"container_scenario\": \"EXPORT\"\n  },\n  \"customer_reference_number\": \"QARGO_TEST_0003\",\n  \"transport_service\": {\n    \"code\": \"CONTAINERS\"\n  }\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"order_identifier\": \"QARGO_TEST_0003\",\n  \"operation\": \"CREATE\",\n  \"customer\": {\n    \"name\": \"UPS SCS Coventry\"\n  },\n  \"setup_stops\": [\n    {\n      \"location\": {\n        \"name\": \"Container yard\",\n        \"address\": \"Scheepzatestraat 1\",\n        \"postal_code\": \"9000\",\n        \"city\": \"Gent\",\n        \"state\": \"Oost-Vlaanderen\",\n        \"country\": \"BE\"\n      },\n      \"note\": \"Pickup empty container on the designated location\",\n      \"date\": \"2024-08-20\",\n      \"reference_number\": \"CONT0001\",\n      \"planning_instructions\": \"Blue container, next to the red container\",\n      \"email\": \"info@qargo.com\",\n      \"phone_number\": \"+0912341431\",\n      \"mobile_number\": \"+324567890\"\n    }\n  ],\n  \"consignments\": [\n    {\n      \"pickup_stop\": {\n        \"location\": {\n          \"name\": \"Container loading location\",\n          \"address\": \"Gaston Crommenlaan 4,\",\n          \"postal_code\": \"9000\",\n          \"city\": \"Gent\",\n          \"state\": \"Oost-Vlaanderen\",\n          \"country\": \"BE\",\n          \"description\": \"Qargo HQ, has a container loading bay\"\n        },\n        \"note\": \"Fill with 1000 boxes of Qargo shirts\",\n        \"date\": \"2024-08-20\",\n        \"reference_number\": \"CONT0002\",\n        \"planning_instructions\": \"Code of the container is 1234\",\n        \"email\": \"info@qargo.com\",\n        \"phone_number\": \"+0912341431\",\n        \"mobile_number\": \"+324567890\"\n      },\n      \"delivery_stop\": {\n        \"location\": {\n          \"name\": \"Train station container hub\",\n          \"address\": \"Resedastraat 20\",\n          \"postal_code\": \"9000\",\n          \"city\": \"Gent\",\n          \"state\": \"Oost-Vlaanderen\",\n          \"country\": \"BE\",\n          \"description\": \"This is the dropoff location of the loaded container\"\n        },\n        \"note\": \"1000 boxes of shoes\",\n        \"date\": \"2024-08-21\",\n        \"reference_number\": \"CONT0003\",\n        \"planning_instructions\": \"Use mobile number if gate is closed\",\n        \"email\": \"info@qargo.com\",\n        \"phone_number\": \"02123456\",\n        \"mobile_number\": \"+329998888\"\n      }\n    }\n  ],\n  \"container\": {\n    \"container_scenario\": \"EXPORT\"\n  },\n  \"customer_reference_number\": \"QARGO_TEST_0003\",\n  \"transport_service\": {\n    \"code\": \"CONTAINERS\"\n  }\n}\n"},"children":[]}]}]}],"sectionId":"/docs/section/transport-order-creation-and-status/export"}],"sectionId":"/docs/section/transport-order-creation-and-status/export"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/transport-order-creation-and-status/create-a-loaded-container-import-transport-order"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a loaded container import transport order"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following order picks up a filled container, delivers it to our office, and returns the empty container."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This examples also demonstrates how to model ADR information."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"operation\": \"CREATE\",\n  \"consignments\": [\n    {\n      \"delivery_stop\": {\n        \"location\": {\n          \"name\": \"Qargo Ghent office\",\n          \"address\": \"Gaston Crommenlaan 4\",\n          \"postal_code\": \"9050\",\n          \"city\": \"Ghent\",\n          \"country\": \"BE\"\n        },\n        \"note\": \"unloading address comments\",\n        \"reference_number\": \"D123956\"\n      },\n      \"pickup_stop\": {\n        \"location\": {\n          \"address\": \"Europaweg\",\n          \"city\": \"Rotterdam\",\n          \"country\": \"NL\",\n          \"name\": \"APM terminals Maasvlakte II\"\n        },\n        \"reference_number\": \"P123956\"\n      },\n      \"goods\": [\n        {\n          \"good_items\": {\n            \"adr\": {\n              \"name\": \"DISINFECTANT, LIQUID, CORROSIVE, N.O.S.\",\n              \"un_number\": \"1903\"\n            }\n          },\n          \"ordered_quantity\": 100,\n          \"ordered_total_volume_value\": 43000,\n          \"packaging_type\": {\n            \"code\": \"PYZ\"\n          }\n        }\n      ]\n    }\n  ],\n  \"container_number\": \"MSCU5285725\",\n  \"container_scenario\": \"IMPORT\",\n  \"container_type\": {\n    \"code\": \"22G0\"\n  },\n  \"customer\": {\n    \"code\": \"00083\"\n  },\n  \"customer_reference_number\": \"C2325995\",\n  \"order_identifier\": \"ord-12332423\",\n  \"teardown_input\": [\n    {\n      \"location\": {\n        \"address\": \"Butaanweg 52-54\",\n        \"city\": \"Rotterdam\",\n        \"country\": \"NL\",\n        \"name\": \"OCC Overbeek Cont. Control.\"\n      }\n    }\n  ],\n  \"transport_service\": {\n    \"name\": \"Container\"\n  }\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"operation\": \"CREATE\",\n  \"consignments\": [\n    {\n      \"delivery_stop\": {\n        \"location\": {\n          \"name\": \"Qargo Ghent office\",\n          \"address\": \"Gaston Crommenlaan 4\",\n          \"postal_code\": \"9050\",\n          \"city\": \"Ghent\",\n          \"country\": \"BE\"\n        },\n        \"note\": \"unloading address comments\",\n        \"reference_number\": \"D123956\"\n      },\n      \"pickup_stop\": {\n        \"location\": {\n          \"address\": \"Europaweg\",\n          \"city\": \"Rotterdam\",\n          \"country\": \"NL\",\n          \"name\": \"APM terminals Maasvlakte II\"\n        },\n        \"reference_number\": \"P123956\"\n      },\n      \"goods\": [\n        {\n          \"good_items\": {\n            \"adr\": {\n              \"name\": \"DISINFECTANT, LIQUID, CORROSIVE, N.O.S.\",\n              \"un_number\": \"1903\"\n            }\n          },\n          \"ordered_quantity\": 100,\n          \"ordered_total_volume_value\": 43000,\n          \"packaging_type\": {\n            \"code\": \"PYZ\"\n          }\n        }\n      ]\n    }\n  ],\n  \"container_number\": \"MSCU5285725\",\n  \"container_scenario\": \"IMPORT\",\n  \"container_type\": {\n    \"code\": \"22G0\"\n  },\n  \"customer\": {\n    \"code\": \"00083\"\n  },\n  \"customer_reference_number\": \"C2325995\",\n  \"order_identifier\": \"ord-12332423\",\n  \"teardown_input\": [\n    {\n      \"location\": {\n        \"address\": \"Butaanweg 52-54\",\n        \"city\": \"Rotterdam\",\n        \"country\": \"NL\",\n        \"name\": \"OCC Overbeek Cont. Control.\"\n      }\n    }\n  ],\n  \"transport_service\": {\n    \"name\": \"Container\"\n  }\n}\n"},"children":[]}]}]}],"sectionId":"/docs/section/transport-order-creation-and-status/create-a-loaded-container-import-transport-order"}],"sectionId":"/docs/section/transport-order-creation-and-status/create-a-loaded-container-import-transport-order"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/transport-order-creation-and-status/create-a-loaded-container-export-transport-order"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a loaded container export transport order"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This example shows how to create a transport that exports a loaded container."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The setup section specifies the empty container pickup."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"operation\": \"CREATE\",\n  \"consignments\": [\n    {\n      \"delivery_stop\": {\n        \"location\": {\n          \"address\": \"Europaweg\",\n          \"city\": \"Rotterdam\",\n          \"country\": \"NL\",\n          \"name\": \"APM terminals Maasvlakte II\"\n        },\n        \"reference_number\": \"3432423908987\"\n      },\n      \"pickup_stop\": {\n        \"location\": {\n          \"name\": \"Qargo Ghent office\",\n          \"address\": \"Gaston Crommenlaan 4\",\n          \"postal_code\": \"9050\",\n          \"city\": \"Ghent\",\n          \"country\": \"BE\"\n        },\n        \"reference_number\": \"3432441\"\n      },\n      \"goods\": [\n        {\n          \"absolute_max_temperature_value\": \"-8.0\",\n          \"description\": \"Plastic buckets\",\n          \"ordered_quantity\": 1500,\n          \"packaging_type\": {\n            \"code\": \"PE\"\n          }\n        }\n      ]\n    }\n  ],\n  \"container_number\": \"MSCU5285725\",\n  \"container_scenario\": \"EXPORT\",\n  \"container_type\": {\n    \"code\": \"22RE\"\n  },\n  \"customer\": {\n    \"code\": \"00007\"\n  },\n  \"customer_reference_number\": \"PUC-888315\",\n  \"order_identifier\": \"d18f8309-0f26-4687-b32b-749008a0cb8e\",\n  \"setup_input\": [\n    {\n      \"location\": {\n        \"address\": \"Butaanweg 52-54\",\n        \"city\": \"Rotterdam\",\n        \"country\": \"NL\",\n        \"name\": \"OCC Overbeek Cont. Control.\"\n      }\n    }\n  ],\n  \"transport_service\": {\n    \"name\": \"Container\"\n  }\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"operation\": \"CREATE\",\n  \"consignments\": [\n    {\n      \"delivery_stop\": {\n        \"location\": {\n          \"address\": \"Europaweg\",\n          \"city\": \"Rotterdam\",\n          \"country\": \"NL\",\n          \"name\": \"APM terminals Maasvlakte II\"\n        },\n        \"reference_number\": \"3432423908987\"\n      },\n      \"pickup_stop\": {\n        \"location\": {\n          \"name\": \"Qargo Ghent office\",\n          \"address\": \"Gaston Crommenlaan 4\",\n          \"postal_code\": \"9050\",\n          \"city\": \"Ghent\",\n          \"country\": \"BE\"\n        },\n        \"reference_number\": \"3432441\"\n      },\n      \"goods\": [\n        {\n          \"absolute_max_temperature_value\": \"-8.0\",\n          \"description\": \"Plastic buckets\",\n          \"ordered_quantity\": 1500,\n          \"packaging_type\": {\n            \"code\": \"PE\"\n          }\n        }\n      ]\n    }\n  ],\n  \"container_number\": \"MSCU5285725\",\n  \"container_scenario\": \"EXPORT\",\n  \"container_type\": {\n    \"code\": \"22RE\"\n  },\n  \"customer\": {\n    \"code\": \"00007\"\n  },\n  \"customer_reference_number\": \"PUC-888315\",\n  \"order_identifier\": \"d18f8309-0f26-4687-b32b-749008a0cb8e\",\n  \"setup_input\": [\n    {\n      \"location\": {\n        \"address\": \"Butaanweg 52-54\",\n        \"city\": \"Rotterdam\",\n        \"country\": \"NL\",\n        \"name\": \"OCC Overbeek Cont. Control.\"\n      }\n    }\n  ],\n  \"transport_service\": {\n    \"name\": \"Container\"\n  }\n}\n"},"children":[]}]}]}],"sectionId":"/docs/section/transport-order-creation-and-status/create-a-loaded-container-export-transport-order"}],"sectionId":"/docs/section/transport-order-creation-and-status/create-a-loaded-container-export-transport-order"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/transport-order-creation-and-status/adding-custom-stops"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adding custom stops"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In Qargo you can define custom stop actions. These stops can be added to configure additional stops related to the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These stops can be defined in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"standalone_stops"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"standalone_stops"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to configure stops adds the following requirements to the order:"},"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":"Every stop needs to have a unique positive integer assigned to it. This will determine the sequence of the stops in the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every stops needs to have a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_activity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" assigned to it. This will determine the type of stop that is being added to the order."},"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":"Example custom stops for an order"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"import_configuration\": {\n    \"code\": \"API\"\n  },\n  \"transport_service\": {\n    \"code\": \"YOUR_TRANSPORT_SERVICE_CODE\"\n  },\n  \"customer\": {\n    \"code\": \"CUSTOMER_CODE\"\n  },\n  \"operation\": \"CREATE\",\n  \"order_identifier\": \"EXT-ORDER-001\",\n  \"customer_reference_number\": \"CUST-REF-001\",\n  \"consignments\": [\n    {\n      \"pickup_stop\": {\n        \"activity\": \"PICKUP\",\n        \"date\": \"2026-04-01\",\n        \"location\": {\n          \"name\": \"Warehouse Antwerp\",\n          \"address\": \"Kaai 100\",\n          \"city\": \"Antwerp\",\n          \"postal_code\": \"2000\",\n          \"country\": \"BE\"\n        },\n        \"position\": {\n          \"optimal\": true,\n          \"position\": 1\n        }\n      },\n      \"delivery_stop\": {\n        \"activity\": \"DELIVERY\",\n        \"date\": \"2026-04-01\",\n        \"location\": {\n          \"name\": \"Distribution Center Ghent\",\n          \"address\": \"Industrieweg 50\",\n          \"city\": \"Ghent\",\n          \"postal_code\": \"9000\",\n          \"country\": \"BE\"\n        },\n        \"position\": {\n          \"optimal\": true,\n          \"position\": 3\n        }\n      },\n      \"standalone_stops\": [\n        {\n          \"activity\": \"CUSTOM\",\n          \"custom_activity_label\": \"WEEG\",\n          \"date\": \"2026-04-01\",\n          \"location\": {\n            \"name\": \"Weigh Station Mechelen\",\n            \"address\": \"Weegbrug 1\",\n            \"city\": \"Mechelen\",\n            \"postal_code\": \"2800\",\n            \"country\": \"BE\"\n          },\n          \"position\": {\n            \"optimal\": true,\n            \"position\": 2\n          }\n        }\n      ],\n      \"goods\": [\n        {\n          \"description\": \"Palletized goods\",\n          \"quantity\": 10,\n          \"package_type\": \"EURO_PALLET\",\n          \"total_weight\": 5000\n        }\n      ]\n    }\n  ]\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"import_configuration\": {\n    \"code\": \"API\"\n  },\n  \"transport_service\": {\n    \"code\": \"YOUR_TRANSPORT_SERVICE_CODE\"\n  },\n  \"customer\": {\n    \"code\": \"CUSTOMER_CODE\"\n  },\n  \"operation\": \"CREATE\",\n  \"order_identifier\": \"EXT-ORDER-001\",\n  \"customer_reference_number\": \"CUST-REF-001\",\n  \"consignments\": [\n    {\n      \"pickup_stop\": {\n        \"activity\": \"PICKUP\",\n        \"date\": \"2026-04-01\",\n        \"location\": {\n          \"name\": \"Warehouse Antwerp\",\n          \"address\": \"Kaai 100\",\n          \"city\": \"Antwerp\",\n          \"postal_code\": \"2000\",\n          \"country\": \"BE\"\n        },\n        \"position\": {\n          \"optimal\": true,\n          \"position\": 1\n        }\n      },\n      \"delivery_stop\": {\n        \"activity\": \"DELIVERY\",\n        \"date\": \"2026-04-01\",\n        \"location\": {\n          \"name\": \"Distribution Center Ghent\",\n          \"address\": \"Industrieweg 50\",\n          \"city\": \"Ghent\",\n          \"postal_code\": \"9000\",\n          \"country\": \"BE\"\n        },\n        \"position\": {\n          \"optimal\": true,\n          \"position\": 3\n        }\n      },\n      \"standalone_stops\": [\n        {\n          \"activity\": \"CUSTOM\",\n          \"custom_activity_label\": \"WEEG\",\n          \"date\": \"2026-04-01\",\n          \"location\": {\n            \"name\": \"Weigh Station Mechelen\",\n            \"address\": \"Weegbrug 1\",\n            \"city\": \"Mechelen\",\n            \"postal_code\": \"2800\",\n            \"country\": \"BE\"\n          },\n          \"position\": {\n            \"optimal\": true,\n            \"position\": 2\n          }\n        }\n      ],\n      \"goods\": [\n        {\n          \"description\": \"Palletized goods\",\n          \"quantity\": 10,\n          \"package_type\": \"EURO_PALLET\",\n          \"total_weight\": 5000\n        }\n      ]\n    }\n  ]\n}\n"},"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":"Example custom stops for an container order"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"order_identifier\": \"QARGO_TEST_0005\",\n  \"operation\": \"CREATE\",\n  \"customer\": {\n    \"name\": \"UPS SCS Coventry\"\n  },\n  \"setup_stops\": [\n    {\n      \"location\": {\n        \"name\": \"Stop 1\",\n        \"address\": \"Scheepzatestraat 1\",\n        \"postal_code\": \"9000\",\n        \"city\": \"Gent\",\n        \"state\": \"Oost-Vlaanderen\",\n        \"country\": \"BE\"\n      },\n      \"note\": \"Stop 1 notes\",\n      \"date\": \"2024-08-20\",\n      \"reference_number\": \"Stop 1 reference number\",\n      \"planning_instructions\": \"Stop 1 instructions\",\n      \"email\": \"info@qargo.com\",\n      \"phone_number\": \"+0912341431\",\n      \"mobile_number\": \"+324567890\",\n      \"activity\": \"COLLECT_EMPTY_CONTAINER\",\n      \"position\": {\n        \"position\": 1\n      }\n    }\n  ],\n  \"consignments\": [\n    {\n      \"standalone_stops\": [\n        {\n          \"location\": {\n            \"name\": \"Stop 2\",\n            \"address\": \"Vlierstraat 4,\",\n            \"postal_code\": \"9000\",\n            \"city\": \"Gent\",\n            \"state\": \"Oost-Vlaanderen\",\n            \"country\": \"BE\",\n            \"description\": \"HQ\"\n          },\n          \"note\": \"Stop 2 notes\",\n          \"date\": \"2024-08-20\",\n          \"reference_number\": \"Stop 2 number\",\n          \"planning_instructions\": \"Stop 2 instructions\",\n          \"email\": \"info@qargo.com\",\n          \"phone_number\": \"+0912341431\",\n          \"mobile_number\": \"+324567890\",\n          \"custom_activity\": \"WEGEN\",\n          \"position\": {\n            \"position\": 2\n          }\n        },\n        {\n          \"location\": {\n            \"name\": \"Stop 6\",\n            \"address\": \"Vlierstraat 4,\",\n            \"postal_code\": \"9000\",\n            \"city\": \"Gent\",\n            \"state\": \"Oost-Vlaanderen\",\n            \"country\": \"BE\",\n            \"description\": \"HQ\"\n          },\n          \"note\": \"Stop 6 notes\",\n          \"date\": \"2024-08-20\",\n          \"reference_number\": \"Stop 6 number\",\n          \"planning_instructions\": \"Stop 6 instructions\",\n          \"email\": \"info@qargo.com\",\n          \"phone_number\": \"+0912341431\",\n          \"mobile_number\": \"+324567890\",\n          \"custom_activity\": \"WEGEN\",\n          \"position\": {\n            \"position\": 6\n          }\n        },\n        {\n          \"location\": {\n            \"name\": \"Stop 3\",\n            \"address\": \"Corbiestraat 4,\",\n            \"postal_code\": \"9000\",\n            \"city\": \"Gent\",\n            \"state\": \"Oost-Vlaanderen\",\n            \"country\": \"BE\"\n          },\n          \"note\": \"Stop 3 notes\",\n          \"date\": \"2024-08-22\",\n          \"reference_number\": \"Stop 3 reference number\",\n          \"planning_instructions\": \"Stop 3 instructions\",\n          \"email\": \"info@qargo.com\",\n          \"phone_number\": \"+0912341431\",\n          \"mobile_number\": \"+324567890\",\n          \"custom_activity\": \"INKLAREN\",\n          \"position\": {\n            \"position\": 3\n          }\n        }\n      ],\n      \"pickup_stop\": {\n        \"location\": {\n          \"name\": \"Stop 4\",\n          \"address\": \"Gaston Crommenlaan 4,\",\n          \"postal_code\": \"9000\",\n          \"city\": \"Gent\",\n          \"state\": \"Oost-Vlaanderen\",\n          \"country\": \"BE\",\n          \"description\": \"HQ\"\n        },\n        \"note\": \"Stop 4 notes\",\n        \"date\": \"2024-08-20\",\n        \"reference_number\": \"Stop 4 reference number\",\n        \"planning_instructions\": \"Stop 4 instructions\",\n        \"email\": \"info@qargo.com\",\n        \"phone_number\": \"+0912341431\",\n        \"mobile_number\": \"+324567890\",\n        \"activity\": \"PICKUP_EXPORT\",\n        \"position\": {\n          \"position\": 4\n        }\n      },\n      \"delivery_stop\": {\n        \"location\": {\n          \"name\": \"Stop 5\",\n          \"address\": \"Resedastraat 20\",\n          \"postal_code\": \"9000\",\n          \"city\": \"Gent\",\n          \"state\": \"Oost-Vlaanderen\",\n          \"country\": \"BE\",\n          \"description\": \"Delivery\"\n        },\n        \"note\": \"Stop 5 notes\",\n        \"date\": \"2024-08-21\",\n        \"reference_number\": \"Stop 5 reference number\",\n        \"planning_instructions\": \"Stop 5 instructions\",\n        \"email\": \"info@qargo.com\",\n        \"phone_number\": \"02123456\",\n        \"mobile_number\": \"+329998888\",\n        \"activity\": \"DELIVERY_EXPORT\",\n        \"position\": {\n          \"position\": 5\n        }\n      }\n    }\n  ],\n  \"container\": {\n    \"container_scenario\": \"EXPORT\"\n  },\n  \"customer_reference_number\": \"QARGO_TEST_0005\",\n  \"transport_service\": {\n    \"code\": \"CONTAINER_BOOKING\"\n  }\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"order_identifier\": \"QARGO_TEST_0005\",\n  \"operation\": \"CREATE\",\n  \"customer\": {\n    \"name\": \"UPS SCS Coventry\"\n  },\n  \"setup_stops\": [\n    {\n      \"location\": {\n        \"name\": \"Stop 1\",\n        \"address\": \"Scheepzatestraat 1\",\n        \"postal_code\": \"9000\",\n        \"city\": \"Gent\",\n        \"state\": \"Oost-Vlaanderen\",\n        \"country\": \"BE\"\n      },\n      \"note\": \"Stop 1 notes\",\n      \"date\": \"2024-08-20\",\n      \"reference_number\": \"Stop 1 reference number\",\n      \"planning_instructions\": \"Stop 1 instructions\",\n      \"email\": \"info@qargo.com\",\n      \"phone_number\": \"+0912341431\",\n      \"mobile_number\": \"+324567890\",\n      \"activity\": \"COLLECT_EMPTY_CONTAINER\",\n      \"position\": {\n        \"position\": 1\n      }\n    }\n  ],\n  \"consignments\": [\n    {\n      \"standalone_stops\": [\n        {\n          \"location\": {\n            \"name\": \"Stop 2\",\n            \"address\": \"Vlierstraat 4,\",\n            \"postal_code\": \"9000\",\n            \"city\": \"Gent\",\n            \"state\": \"Oost-Vlaanderen\",\n            \"country\": \"BE\",\n            \"description\": \"HQ\"\n          },\n          \"note\": \"Stop 2 notes\",\n          \"date\": \"2024-08-20\",\n          \"reference_number\": \"Stop 2 number\",\n          \"planning_instructions\": \"Stop 2 instructions\",\n          \"email\": \"info@qargo.com\",\n          \"phone_number\": \"+0912341431\",\n          \"mobile_number\": \"+324567890\",\n          \"custom_activity\": \"WEGEN\",\n          \"position\": {\n            \"position\": 2\n          }\n        },\n        {\n          \"location\": {\n            \"name\": \"Stop 6\",\n            \"address\": \"Vlierstraat 4,\",\n            \"postal_code\": \"9000\",\n            \"city\": \"Gent\",\n            \"state\": \"Oost-Vlaanderen\",\n            \"country\": \"BE\",\n            \"description\": \"HQ\"\n          },\n          \"note\": \"Stop 6 notes\",\n          \"date\": \"2024-08-20\",\n          \"reference_number\": \"Stop 6 number\",\n          \"planning_instructions\": \"Stop 6 instructions\",\n          \"email\": \"info@qargo.com\",\n          \"phone_number\": \"+0912341431\",\n          \"mobile_number\": \"+324567890\",\n          \"custom_activity\": \"WEGEN\",\n          \"position\": {\n            \"position\": 6\n          }\n        },\n        {\n          \"location\": {\n            \"name\": \"Stop 3\",\n            \"address\": \"Corbiestraat 4,\",\n            \"postal_code\": \"9000\",\n            \"city\": \"Gent\",\n            \"state\": \"Oost-Vlaanderen\",\n            \"country\": \"BE\"\n          },\n          \"note\": \"Stop 3 notes\",\n          \"date\": \"2024-08-22\",\n          \"reference_number\": \"Stop 3 reference number\",\n          \"planning_instructions\": \"Stop 3 instructions\",\n          \"email\": \"info@qargo.com\",\n          \"phone_number\": \"+0912341431\",\n          \"mobile_number\": \"+324567890\",\n          \"custom_activity\": \"INKLAREN\",\n          \"position\": {\n            \"position\": 3\n          }\n        }\n      ],\n      \"pickup_stop\": {\n        \"location\": {\n          \"name\": \"Stop 4\",\n          \"address\": \"Gaston Crommenlaan 4,\",\n          \"postal_code\": \"9000\",\n          \"city\": \"Gent\",\n          \"state\": \"Oost-Vlaanderen\",\n          \"country\": \"BE\",\n          \"description\": \"HQ\"\n        },\n        \"note\": \"Stop 4 notes\",\n        \"date\": \"2024-08-20\",\n        \"reference_number\": \"Stop 4 reference number\",\n        \"planning_instructions\": \"Stop 4 instructions\",\n        \"email\": \"info@qargo.com\",\n        \"phone_number\": \"+0912341431\",\n        \"mobile_number\": \"+324567890\",\n        \"activity\": \"PICKUP_EXPORT\",\n        \"position\": {\n          \"position\": 4\n        }\n      },\n      \"delivery_stop\": {\n        \"location\": {\n          \"name\": \"Stop 5\",\n          \"address\": \"Resedastraat 20\",\n          \"postal_code\": \"9000\",\n          \"city\": \"Gent\",\n          \"state\": \"Oost-Vlaanderen\",\n          \"country\": \"BE\",\n          \"description\": \"Delivery\"\n        },\n        \"note\": \"Stop 5 notes\",\n        \"date\": \"2024-08-21\",\n        \"reference_number\": \"Stop 5 reference number\",\n        \"planning_instructions\": \"Stop 5 instructions\",\n        \"email\": \"info@qargo.com\",\n        \"phone_number\": \"02123456\",\n        \"mobile_number\": \"+329998888\",\n        \"activity\": \"DELIVERY_EXPORT\",\n        \"position\": {\n          \"position\": 5\n        }\n      }\n    }\n  ],\n  \"container\": {\n    \"container_scenario\": \"EXPORT\"\n  },\n  \"customer_reference_number\": \"QARGO_TEST_0005\",\n  \"transport_service\": {\n    \"code\": \"CONTAINER_BOOKING\"\n  }\n}\n"},"children":[]}]}]}],"sectionId":"/docs/section/transport-order-creation-and-status/adding-custom-stops"}],"sectionId":"/docs/section/transport-order-creation-and-status/adding-custom-stops"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/transport-order-creation-and-status/examples"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples"},"children":[]}]}]}]}],"sectionId":"/docs/section/transport-order-creation-and-status/examples"}],"sectionId":"/docs/section/transport-order-creation-and-status/examples"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/transport-order-creation-and-status/basic-order"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Basic order"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"order_identifier\": \"DEFAULT_ORDER\",\n  \"operation\": \"CREATE\",\n  \"customer\": { \"name\": \"Qargo\" },\n  \"import_configuration\": { \"code\": \"API\" },\n  \"consignments\": [\n    {\n      \"pickup_stop\": {\n        \"location\": {\n          \"name\": \"Qargo\",\n          \"address\": \"Gaston Crommenlaan 4\",\n          \"postal_code\": \"9000\",\n          \"city\": \"Gent\",\n          \"state\": \"Oost-Vlaanderen\",\n          \"country\": \"BE\",\n          \"description\": \"HQ\"\n        },\n        \"note\": \"Collection notes\",\n        \"date\": \"2024-07-19\",\n        \"reference_number\": \"\",\n        \"planning_instructions\": \"\",\n        \"email\": \"\",\n        \"phone_number\": \"\",\n        \"mobile_number\": \"\"\n      },\n      \"delivery_stop\": {\n        \"location\": {\n          \"name\": \"Qargo London\",\n          \"address\": \"71-91 Aldwych\",\n          \"postal_code\": \"WC2B 4HN\",\n          \"city\": \"London\",\n          \"country\": \"GB\",\n          \"description\": \"Delivery\"\n        },\n        \"note\": \"Delivery notes\",\n        \"date\": \"2024-07-19\",\n        \"reference_number\": \"\",\n        \"planning_instructions\": \"\",\n        \"email\": \"\",\n        \"phone_number\": \"\",\n        \"mobile_number\": \"\"\n      },\n      \"goods\": [{ \"quantity\": 1 }]\n    }\n  ],\n  \"customer_reference_number\": \"QARGO-123\",\n  \"transport_service\": { \"code\": \"QARGO\" },\n  \"service_level\": { \"code\": \"QARGO_NEXT_DAY\" }\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"order_identifier\": \"DEFAULT_ORDER\",\n  \"operation\": \"CREATE\",\n  \"customer\": { \"name\": \"Qargo\" },\n  \"import_configuration\": { \"code\": \"API\" },\n  \"consignments\": [\n    {\n      \"pickup_stop\": {\n        \"location\": {\n          \"name\": \"Qargo\",\n          \"address\": \"Gaston Crommenlaan 4\",\n          \"postal_code\": \"9000\",\n          \"city\": \"Gent\",\n          \"state\": \"Oost-Vlaanderen\",\n          \"country\": \"BE\",\n          \"description\": \"HQ\"\n        },\n        \"note\": \"Collection notes\",\n        \"date\": \"2024-07-19\",\n        \"reference_number\": \"\",\n        \"planning_instructions\": \"\",\n        \"email\": \"\",\n        \"phone_number\": \"\",\n        \"mobile_number\": \"\"\n      },\n      \"delivery_stop\": {\n        \"location\": {\n          \"name\": \"Qargo London\",\n          \"address\": \"71-91 Aldwych\",\n          \"postal_code\": \"WC2B 4HN\",\n          \"city\": \"London\",\n          \"country\": \"GB\",\n          \"description\": \"Delivery\"\n        },\n        \"note\": \"Delivery notes\",\n        \"date\": \"2024-07-19\",\n        \"reference_number\": \"\",\n        \"planning_instructions\": \"\",\n        \"email\": \"\",\n        \"phone_number\": \"\",\n        \"mobile_number\": \"\"\n      },\n      \"goods\": [{ \"quantity\": 1 }]\n    }\n  ],\n  \"customer_reference_number\": \"QARGO-123\",\n  \"transport_service\": { \"code\": \"QARGO\" },\n  \"service_level\": { \"code\": \"QARGO_NEXT_DAY\" }\n}\n"},"children":[]}]}]}],"sectionId":"/docs/section/transport-order-creation-and-status/basic-order"}],"sectionId":"/docs/section/transport-order-creation-and-status/basic-order"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/transport-order-creation-and-status/container-import-scenario"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container IMPORT scenario"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"order_identifier\": \"CONTAINER_IMPORT_ORDER\",\n  \"operation\": \"CREATE\",\n  \"customer\": { \"name\": \"QARGO\" },\n  \"import_configuration\": { \"code\": \"API\" },\n  \"teardown_stops\": [\n    {\n      \"location\": {\n        \"name\": \"Ghent Container Yard\",\n        \"address\": \"Scheepzatestraat 1\",\n        \"postal_code\": \"9000\",\n        \"city\": \"Gent\",\n        \"state\": \"Oost-Vlaanderen\",\n        \"country\": \"BE\"\n      },\n      \"note\": \"Empty container drop-off\",\n      \"date\": \"2024-08-24\",\n      \"reference_number\": \"\",\n      \"planning_instructions\": \"\",\n      \"email\": \"\",\n      \"phone_number\": \"\",\n      \"mobile_number\": \"\"\n    }\n  ],\n  \"consignments\": [\n    {\n      \"pickup_stop\": {\n        \"location\": {\n          \"name\": \"Qargo Ghent\",\n          \"address\": \"Gaston Crommenlaan 4,\",\n          \"postal_code\": \"9000\",\n          \"city\": \"Gent\",\n          \"state\": \"Oost-Vlaanderen\",\n          \"country\": \"BE\",\n          \"description\": \"\"\n        },\n        \"note\": \"\",\n        \"date\": \"2024-08-20\",\n        \"reference_number\": \"\",\n        \"planning_instructions\": \"\",\n        \"email\": \"\",\n        \"phone_number\": \"\",\n        \"mobile_number\": \"\"\n      },\n      \"delivery_stop\": {\n        \"location\": {\n          \"name\": \"Qargo London\",\n          \"address\": \"71-91 Aldwych\",\n          \"postal_code\": \"WC2B 4HN\",\n          \"city\": \"London\",\n          \"country\": \"GB\",\n          \"description\": \"Delivery\"\n        },\n        \"note\": \"Delivery notes\",\n        \"date\": \"2024-08-22\",\n        \"reference_number\": \"\",\n        \"planning_instructions\": \"\",\n        \"email\": \"\",\n        \"phone_number\": \"\",\n        \"mobile_number\": \"\"\n      }\n    }\n  ],\n  \"container\": { \"container_scenario\": \"IMPORT\", \"seal_number\": \"SEAL12345\" },\n  \"customer_reference_number\": \"QARGO-01\",\n  \"transport_service\": { \"code\": \"CONTAINER_TRANSPORT_SERVICE\" }\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"order_identifier\": \"CONTAINER_IMPORT_ORDER\",\n  \"operation\": \"CREATE\",\n  \"customer\": { \"name\": \"QARGO\" },\n  \"import_configuration\": { \"code\": \"API\" },\n  \"teardown_stops\": [\n    {\n      \"location\": {\n        \"name\": \"Ghent Container Yard\",\n        \"address\": \"Scheepzatestraat 1\",\n        \"postal_code\": \"9000\",\n        \"city\": \"Gent\",\n        \"state\": \"Oost-Vlaanderen\",\n        \"country\": \"BE\"\n      },\n      \"note\": \"Empty container drop-off\",\n      \"date\": \"2024-08-24\",\n      \"reference_number\": \"\",\n      \"planning_instructions\": \"\",\n      \"email\": \"\",\n      \"phone_number\": \"\",\n      \"mobile_number\": \"\"\n    }\n  ],\n  \"consignments\": [\n    {\n      \"pickup_stop\": {\n        \"location\": {\n          \"name\": \"Qargo Ghent\",\n          \"address\": \"Gaston Crommenlaan 4,\",\n          \"postal_code\": \"9000\",\n          \"city\": \"Gent\",\n          \"state\": \"Oost-Vlaanderen\",\n          \"country\": \"BE\",\n          \"description\": \"\"\n        },\n        \"note\": \"\",\n        \"date\": \"2024-08-20\",\n        \"reference_number\": \"\",\n        \"planning_instructions\": \"\",\n        \"email\": \"\",\n        \"phone_number\": \"\",\n        \"mobile_number\": \"\"\n      },\n      \"delivery_stop\": {\n        \"location\": {\n          \"name\": \"Qargo London\",\n          \"address\": \"71-91 Aldwych\",\n          \"postal_code\": \"WC2B 4HN\",\n          \"city\": \"London\",\n          \"country\": \"GB\",\n          \"description\": \"Delivery\"\n        },\n        \"note\": \"Delivery notes\",\n        \"date\": \"2024-08-22\",\n        \"reference_number\": \"\",\n        \"planning_instructions\": \"\",\n        \"email\": \"\",\n        \"phone_number\": \"\",\n        \"mobile_number\": \"\"\n      }\n    }\n  ],\n  \"container\": { \"container_scenario\": \"IMPORT\", \"seal_number\": \"SEAL12345\" },\n  \"customer_reference_number\": \"QARGO-01\",\n  \"transport_service\": { \"code\": \"CONTAINER_TRANSPORT_SERVICE\" }\n}\n"},"children":[]}]}]}],"sectionId":"/docs/section/transport-order-creation-and-status/container-import-scenario"}],"sectionId":"/docs/section/transport-order-creation-and-status/container-import-scenario"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/transport-order-creation-and-status/container-export-scenario"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container EXPORT scenario"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"order_identifier\": \"CONTAINER_EXPORT_ORDER\",\n  \"operation\": \"CREATE\",\n  \"customer\": { \"name\": \"QARGO\" },\n  \"import_configuration\": { \"code\": \"API\" },\n  \"setup_stops\": [\n    {\n      \"location\": {\n        \"name\": \"Ghent Container Yard\",\n        \"address\": \"Scheepzatestraat 1\",\n        \"postal_code\": \"9000\",\n        \"city\": \"Gent\",\n        \"state\": \"Oost-Vlaanderen\",\n        \"country\": \"BE\"\n      },\n      \"note\": \"Empty container pickup location\",\n      \"date\": \"2024-08-20\",\n      \"reference_number\": \"\",\n      \"planning_instructions\": \"\",\n      \"email\": \"\",\n      \"phone_number\": \"\",\n      \"mobile_number\": \"\"\n    }\n  ],\n  \"consignments\": [\n    {\n      \"pickup_stop\": {\n        \"location\": {\n          \"name\": \"Qargo Ghent\",\n          \"address\": \"Gaston Crommenlaan 4,\",\n          \"postal_code\": \"9000\",\n          \"city\": \"Gent\",\n          \"state\": \"Oost-Vlaanderen\",\n          \"country\": \"BE\",\n          \"description\": \"\"\n        },\n        \"note\": \"\",\n        \"date\": \"2024-08-20\",\n        \"reference_number\": \"\",\n        \"planning_instructions\": \"\",\n        \"email\": \"\",\n        \"phone_number\": \"\",\n        \"mobile_number\": \"\"\n      },\n      \"delivery_stop\": {\n        \"location\": {\n          \"name\": \"Qargo London\",\n          \"address\": \"71-91 Aldwych\",\n          \"postal_code\": \"WC2B 4HN\",\n          \"city\": \"London\",\n          \"country\": \"GB\",\n          \"description\": \"Delivery\"\n        },\n        \"note\": \"Delivery notes\",\n        \"date\": \"2024-08-22\",\n        \"reference_number\": \"\",\n        \"planning_instructions\": \"\",\n        \"email\": \"\",\n        \"phone_number\": \"\",\n        \"mobile_number\": \"\"\n      }\n    }\n  ],\n  \"container\": { \"container_scenario\": \"EXPORT\", \"seal_number\": \"SEAL12345\" },\n  \"customer_reference_number\": \"QARGO-00003\",\n  \"transport_service\": { \"code\": \"CONTAINER_TRANSPORT_SERVICE\" }\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"order_identifier\": \"CONTAINER_EXPORT_ORDER\",\n  \"operation\": \"CREATE\",\n  \"customer\": { \"name\": \"QARGO\" },\n  \"import_configuration\": { \"code\": \"API\" },\n  \"setup_stops\": [\n    {\n      \"location\": {\n        \"name\": \"Ghent Container Yard\",\n        \"address\": \"Scheepzatestraat 1\",\n        \"postal_code\": \"9000\",\n        \"city\": \"Gent\",\n        \"state\": \"Oost-Vlaanderen\",\n        \"country\": \"BE\"\n      },\n      \"note\": \"Empty container pickup location\",\n      \"date\": \"2024-08-20\",\n      \"reference_number\": \"\",\n      \"planning_instructions\": \"\",\n      \"email\": \"\",\n      \"phone_number\": \"\",\n      \"mobile_number\": \"\"\n    }\n  ],\n  \"consignments\": [\n    {\n      \"pickup_stop\": {\n        \"location\": {\n          \"name\": \"Qargo Ghent\",\n          \"address\": \"Gaston Crommenlaan 4,\",\n          \"postal_code\": \"9000\",\n          \"city\": \"Gent\",\n          \"state\": \"Oost-Vlaanderen\",\n          \"country\": \"BE\",\n          \"description\": \"\"\n        },\n        \"note\": \"\",\n        \"date\": \"2024-08-20\",\n        \"reference_number\": \"\",\n        \"planning_instructions\": \"\",\n        \"email\": \"\",\n        \"phone_number\": \"\",\n        \"mobile_number\": \"\"\n      },\n      \"delivery_stop\": {\n        \"location\": {\n          \"name\": \"Qargo London\",\n          \"address\": \"71-91 Aldwych\",\n          \"postal_code\": \"WC2B 4HN\",\n          \"city\": \"London\",\n          \"country\": \"GB\",\n          \"description\": \"Delivery\"\n        },\n        \"note\": \"Delivery notes\",\n        \"date\": \"2024-08-22\",\n        \"reference_number\": \"\",\n        \"planning_instructions\": \"\",\n        \"email\": \"\",\n        \"phone_number\": \"\",\n        \"mobile_number\": \"\"\n      }\n    }\n  ],\n  \"container\": { \"container_scenario\": \"EXPORT\", \"seal_number\": \"SEAL12345\" },\n  \"customer_reference_number\": \"QARGO-00003\",\n  \"transport_service\": { \"code\": \"CONTAINER_TRANSPORT_SERVICE\" }\n}\n"},"children":[]}]}]}],"sectionId":"/docs/section/transport-order-creation-and-status/container-export-scenario"}],"sectionId":"/docs/section/transport-order-creation-and-status/container-export-scenario"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/transport-order-creation-and-status/order-with-multiple-stops-example"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order with multiple stops example"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"order_identifier\": \"MULTIPLE_STOPS_ORDER\",\n  \"operation\": \"CREATE\",\n  \"customer\": { \"name\": \"QARGO\" },\n  \"consignments\": [\n    {\n      \"standalone_stops\": [\n        {\n          \"location\": {\n            \"name\": \"Customs Ghent\",\n            \"address\": \"Sint-Lievenslaan 27\",\n            \"postal_code\": \"9000\",\n            \"city\": \"Gent\",\n            \"state\": \"Oost-Vlaanderen\",\n            \"country\": \"BE\",\n            \"description\": \"Customs office location\"\n          },\n          \"note\": \"\",\n          \"date\": \"2024-08-20\",\n          \"reference_number\": \"\",\n          \"planning_instructions\": \"\",\n          \"email\": \"\",\n          \"phone_number\": \"\",\n          \"mobile_number\": \"\",\n          \"custom_activity\": \"CUSTOMS\",\n          \"position\": { \"position\": 1 }\n        },\n        {\n          \"location\": {\n            \"name\": \"Truck weight station\",\n            \"address\": \"Belgicastraat 10\",\n            \"postal_code\": \"9000\",\n            \"city\": \"Gent\",\n            \"state\": \"Oost-Vlaanderen\",\n            \"country\": \"BE\",\n            \"description\": \"HQ\"\n          },\n          \"note\": \"\",\n          \"date\": \"2024-08-20\",\n          \"reference_number\": \"\",\n          \"planning_instructions\": \"\",\n          \"email\": \"\",\n          \"phone_number\": \"\",\n          \"mobile_number\": \"\",\n          \"custom_activity\": \"WEIGHT_STATION\",\n          \"position\": { \"position\": 2 }\n        },\n        {\n          \"location\": {\n            \"name\": \"Truckwash Ghent\",\n            \"address\": \"Traktaatweg 23\",\n            \"postal_code\": \"9000\",\n            \"city\": \"Gent\",\n            \"state\": \"Oost-Vlaanderen\",\n            \"country\": \"BE\"\n          },\n          \"note\": \"\",\n          \"date\": \"2024-08-23\",\n          \"reference_number\": \"\",\n          \"planning_instructions\": \"\",\n          \"email\": \"\",\n          \"phone_number\": \"\",\n          \"mobile_number\": \"\",\n          \"custom_activity\": \"WASHING\",\n          \"position\": { \"position\": 5 }\n        }\n      ],\n      \"pickup_stop\": {\n        \"location\": {\n          \"name\": \"Qargo Ghent\",\n          \"address\": \"Gaston Crommenlaan 4,\",\n          \"postal_code\": \"9000\",\n          \"city\": \"Gent\",\n          \"state\": \"Oost-Vlaanderen\",\n          \"country\": \"BE\",\n          \"description\": \"\"\n        },\n        \"note\": \"\",\n        \"date\": \"2024-08-20\",\n        \"reference_number\": \"\",\n        \"planning_instructions\": \"\",\n        \"email\": \"\",\n        \"phone_number\": \"\",\n        \"mobile_number\": \"\",\n        \"activity\": \"PICKUP\",\n        \"position\": { \"position\": 3 }\n      },\n      \"delivery_stop\": {\n        \"location\": {\n          \"name\": \"Qargo London\",\n          \"address\": \"71-91 Aldwych\",\n          \"postal_code\": \"WC2B 4HN\",\n          \"city\": \"London\",\n          \"country\": \"GB\",\n          \"description\": \"Delivery\"\n        },\n        \"note\": \"Delivery notes\",\n        \"date\": \"2024-08-22\",\n        \"reference_number\": \"\",\n        \"planning_instructions\": \"\",\n        \"email\": \"\",\n        \"phone_number\": \"\",\n        \"mobile_number\": \"\",\n        \"activity\": \"DELIVERY\",\n        \"position\": { \"position\": 4 }\n      }\n    }\n  ],\n  \"customer_reference_number\": \"QARGO_001\",\n  \"transport_service\": { \"code\": \"FULL_LOADS\" }\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"order_identifier\": \"MULTIPLE_STOPS_ORDER\",\n  \"operation\": \"CREATE\",\n  \"customer\": { \"name\": \"QARGO\" },\n  \"consignments\": [\n    {\n      \"standalone_stops\": [\n        {\n          \"location\": {\n            \"name\": \"Customs Ghent\",\n            \"address\": \"Sint-Lievenslaan 27\",\n            \"postal_code\": \"9000\",\n            \"city\": \"Gent\",\n            \"state\": \"Oost-Vlaanderen\",\n            \"country\": \"BE\",\n            \"description\": \"Customs office location\"\n          },\n          \"note\": \"\",\n          \"date\": \"2024-08-20\",\n          \"reference_number\": \"\",\n          \"planning_instructions\": \"\",\n          \"email\": \"\",\n          \"phone_number\": \"\",\n          \"mobile_number\": \"\",\n          \"custom_activity\": \"CUSTOMS\",\n          \"position\": { \"position\": 1 }\n        },\n        {\n          \"location\": {\n            \"name\": \"Truck weight station\",\n            \"address\": \"Belgicastraat 10\",\n            \"postal_code\": \"9000\",\n            \"city\": \"Gent\",\n            \"state\": \"Oost-Vlaanderen\",\n            \"country\": \"BE\",\n            \"description\": \"HQ\"\n          },\n          \"note\": \"\",\n          \"date\": \"2024-08-20\",\n          \"reference_number\": \"\",\n          \"planning_instructions\": \"\",\n          \"email\": \"\",\n          \"phone_number\": \"\",\n          \"mobile_number\": \"\",\n          \"custom_activity\": \"WEIGHT_STATION\",\n          \"position\": { \"position\": 2 }\n        },\n        {\n          \"location\": {\n            \"name\": \"Truckwash Ghent\",\n            \"address\": \"Traktaatweg 23\",\n            \"postal_code\": \"9000\",\n            \"city\": \"Gent\",\n            \"state\": \"Oost-Vlaanderen\",\n            \"country\": \"BE\"\n          },\n          \"note\": \"\",\n          \"date\": \"2024-08-23\",\n          \"reference_number\": \"\",\n          \"planning_instructions\": \"\",\n          \"email\": \"\",\n          \"phone_number\": \"\",\n          \"mobile_number\": \"\",\n          \"custom_activity\": \"WASHING\",\n          \"position\": { \"position\": 5 }\n        }\n      ],\n      \"pickup_stop\": {\n        \"location\": {\n          \"name\": \"Qargo Ghent\",\n          \"address\": \"Gaston Crommenlaan 4,\",\n          \"postal_code\": \"9000\",\n          \"city\": \"Gent\",\n          \"state\": \"Oost-Vlaanderen\",\n          \"country\": \"BE\",\n          \"description\": \"\"\n        },\n        \"note\": \"\",\n        \"date\": \"2024-08-20\",\n        \"reference_number\": \"\",\n        \"planning_instructions\": \"\",\n        \"email\": \"\",\n        \"phone_number\": \"\",\n        \"mobile_number\": \"\",\n        \"activity\": \"PICKUP\",\n        \"position\": { \"position\": 3 }\n      },\n      \"delivery_stop\": {\n        \"location\": {\n          \"name\": \"Qargo London\",\n          \"address\": \"71-91 Aldwych\",\n          \"postal_code\": \"WC2B 4HN\",\n          \"city\": \"London\",\n          \"country\": \"GB\",\n          \"description\": \"Delivery\"\n        },\n        \"note\": \"Delivery notes\",\n        \"date\": \"2024-08-22\",\n        \"reference_number\": \"\",\n        \"planning_instructions\": \"\",\n        \"email\": \"\",\n        \"phone_number\": \"\",\n        \"mobile_number\": \"\",\n        \"activity\": \"DELIVERY\",\n        \"position\": { \"position\": 4 }\n      }\n    }\n  ],\n  \"customer_reference_number\": \"QARGO_001\",\n  \"transport_service\": { \"code\": \"FULL_LOADS\" }\n}\n"},"children":[]}]}]}],"sectionId":"/docs/section/transport-order-creation-and-status/order-with-multiple-stops-example"}],"sectionId":"/docs/section/transport-order-creation-and-status/order-with-multiple-stops-example"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/transport-order-creation-and-status/order-with-adr-goods"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order with ADR goods"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"technical_name_by_locale"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is writable; use it to provide localized technical names for the dangerous goods. Each key"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"must be a supported locale code, and each value is the technical name for that locale. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"adr_name_by_locale"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"read-only; the API generates this field automatically and ignores any submitted value. The example below provides"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"technical names for four locales."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"order_identifier\": \"DANGEROUS_GOODS_ORDER\",\n  \"operation\": \"CREATE\",\n  \"customer\": { \"name\": \"QARGO\" },\n  \"import_configuration\": { \"code\": \"API\" },\n  \"consignments\": [\n    {\n      \"pickup_stop\": {\n        \"location\": {\n          \"name\": \"Qargo Ghent\",\n          \"address\": \"Gaston Crommenlaan 4,\",\n          \"postal_code\": \"9000\",\n          \"city\": \"Gent\",\n          \"state\": \"Oost-Vlaanderen\",\n          \"country\": \"BE\",\n          \"description\": \"\"\n        },\n        \"note\": \"\",\n        \"date\": \"2024-08-20\",\n        \"reference_number\": \"\",\n        \"planning_instructions\": \"\",\n        \"email\": \"\",\n        \"phone_number\": \"\",\n        \"mobile_number\": \"\"\n      },\n      \"delivery_stop\": {\n        \"location\": {\n          \"name\": \"Qargo London\",\n          \"address\": \"71-91 Aldwych\",\n          \"postal_code\": \"WC2B 4HN\",\n          \"city\": \"London\",\n          \"country\": \"GB\",\n          \"description\": \"Delivery\"\n        },\n        \"note\": \"Delivery notes\",\n        \"date\": \"2024-08-22\",\n        \"reference_number\": \"\",\n        \"planning_instructions\": \"\",\n        \"email\": \"\",\n        \"phone_number\": \"\",\n        \"mobile_number\": \"\"\n      },\n      \"goods\": [\n        {\n          \"packaged_items\": [\n            {\n              \"adr\": {\n                \"un_number\": \"1956\",\n                \"packaging_type\": \"BOX\",\n                \"emergency_phone_number\": \"+32456789010\",\n                \"technical_name_by_locale\": {\n                  \"de-DE\": \"NEG Stoffname\",\n                  \"en\": \"NEG Substance name\",\n                  \"fr-FR\": \"NEG Nom de la substance\",\n                  \"nl-BE\": \"NEG Stofnaam\"\n                }\n              },\n              \"quantity\": 5,\n              \"total_volume_l\": 100,\n              \"total_weight_kg\": 100,\n              \"description\": \"Dangerous and flammable goods\"\n            }\n          ],\n          \"description\": \"Fuel\",\n          \"quantity\": 1,\n          \"product_name\": \"FUEL\"\n        }\n      ]\n    }\n  ],\n  \"customer_reference_number\": \"QARGO-001\",\n  \"transport_service\": { \"code\": \"HAZARDOUS\" },\n  \"service_level\": { \"code\": \"NEXT_DAY\" }\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"order_identifier\": \"DANGEROUS_GOODS_ORDER\",\n  \"operation\": \"CREATE\",\n  \"customer\": { \"name\": \"QARGO\" },\n  \"import_configuration\": { \"code\": \"API\" },\n  \"consignments\": [\n    {\n      \"pickup_stop\": {\n        \"location\": {\n          \"name\": \"Qargo Ghent\",\n          \"address\": \"Gaston Crommenlaan 4,\",\n          \"postal_code\": \"9000\",\n          \"city\": \"Gent\",\n          \"state\": \"Oost-Vlaanderen\",\n          \"country\": \"BE\",\n          \"description\": \"\"\n        },\n        \"note\": \"\",\n        \"date\": \"2024-08-20\",\n        \"reference_number\": \"\",\n        \"planning_instructions\": \"\",\n        \"email\": \"\",\n        \"phone_number\": \"\",\n        \"mobile_number\": \"\"\n      },\n      \"delivery_stop\": {\n        \"location\": {\n          \"name\": \"Qargo London\",\n          \"address\": \"71-91 Aldwych\",\n          \"postal_code\": \"WC2B 4HN\",\n          \"city\": \"London\",\n          \"country\": \"GB\",\n          \"description\": \"Delivery\"\n        },\n        \"note\": \"Delivery notes\",\n        \"date\": \"2024-08-22\",\n        \"reference_number\": \"\",\n        \"planning_instructions\": \"\",\n        \"email\": \"\",\n        \"phone_number\": \"\",\n        \"mobile_number\": \"\"\n      },\n      \"goods\": [\n        {\n          \"packaged_items\": [\n            {\n              \"adr\": {\n                \"un_number\": \"1956\",\n                \"packaging_type\": \"BOX\",\n                \"emergency_phone_number\": \"+32456789010\",\n                \"technical_name_by_locale\": {\n                  \"de-DE\": \"NEG Stoffname\",\n                  \"en\": \"NEG Substance name\",\n                  \"fr-FR\": \"NEG Nom de la substance\",\n                  \"nl-BE\": \"NEG Stofnaam\"\n                }\n              },\n              \"quantity\": 5,\n              \"total_volume_l\": 100,\n              \"total_weight_kg\": 100,\n              \"description\": \"Dangerous and flammable goods\"\n            }\n          ],\n          \"description\": \"Fuel\",\n          \"quantity\": 1,\n          \"product_name\": \"FUEL\"\n        }\n      ]\n    }\n  ],\n  \"customer_reference_number\": \"QARGO-001\",\n  \"transport_service\": { \"code\": \"HAZARDOUS\" },\n  \"service_level\": { \"code\": \"NEXT_DAY\" }\n}\n"},"children":[]}]}]}],"sectionId":"/docs/section/transport-order-creation-and-status/order-with-adr-goods"}],"sectionId":"/docs/section/transport-order-creation-and-status/order-with-adr-goods"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/transport-order-creation-and-status/order-with-pallets-and-custom-barcodes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order with pallets and custom barcodes"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"order_identifier\": \"PALLETS_WITH_BARCODES_ORDER\",\n  \"operation\": \"CREATE\",\n  \"customer\": { \"name\": \"QARGO\" },\n  \"import_configuration\": { \"code\": \"API\" },\n  \"consignments\": [\n    {\n      \"pickup_stop\": {\n        \"location\": {\n          \"name\": \"Qargo Ghent\",\n          \"address\": \"Gaston Crommenlaan 4,\",\n          \"postal_code\": \"9000\",\n          \"city\": \"Gent\",\n          \"state\": \"Oost-Vlaanderen\",\n          \"country\": \"BE\",\n          \"description\": \"\"\n        },\n        \"note\": \"\",\n        \"date\": \"2024-08-20\",\n        \"reference_number\": \"\",\n        \"planning_instructions\": \"\",\n        \"email\": \"\",\n        \"phone_number\": \"\",\n        \"mobile_number\": \"\"\n      },\n      \"delivery_stop\": {\n        \"location\": {\n          \"name\": \"Qargo London\",\n          \"address\": \"71-91 Aldwych\",\n          \"postal_code\": \"WC2B 4HN\",\n          \"city\": \"London\",\n          \"country\": \"GB\",\n          \"description\": \"Delivery\"\n        },\n        \"note\": \"Delivery notes\",\n        \"date\": \"2024-08-22\",\n        \"reference_number\": \"\",\n        \"planning_instructions\": \"\",\n        \"email\": \"\",\n        \"phone_number\": \"\",\n        \"mobile_number\": \"\"\n      },\n      \"goods\": [\n        {\n          \"quantity\": 1,\n          \"packaging_type\": {\n            \"name\": \"Full Pallet\",\n            \"packaging_size\": { \"code\": \"FP\" }\n          },\n          \"handling_units\": [\n            { \"barcode\": { \"value\": \"01J93R8V517R7133FVCM3ZCJNN\" } }\n          ]\n        },\n        {\n          \"quantity\": 2,\n          \"packaging_type\": {\n            \"name\": \"Half Pallet\",\n            \"packaging_size\": { \"code\": \"HP\" }\n          },\n          \"handling_units\": [\n            { \"barcode\": { \"value\": \"01J93R9024CNTJJPQG8WDP2PVX\" } },\n            { \"barcode\": { \"value\": \"01J93R9PKY3A5C9S6T4VV12C8B\" } }\n          ]\n        }\n      ]\n    }\n  ],\n  \"customer_reference_number\": \"QARGO-0001\",\n  \"transport_service\": { \"code\": \"PALLETS\" },\n  \"service_level\": { \"code\": \"PREMIUM_NEXT_DAY\" }\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"order_identifier\": \"PALLETS_WITH_BARCODES_ORDER\",\n  \"operation\": \"CREATE\",\n  \"customer\": { \"name\": \"QARGO\" },\n  \"import_configuration\": { \"code\": \"API\" },\n  \"consignments\": [\n    {\n      \"pickup_stop\": {\n        \"location\": {\n          \"name\": \"Qargo Ghent\",\n          \"address\": \"Gaston Crommenlaan 4,\",\n          \"postal_code\": \"9000\",\n          \"city\": \"Gent\",\n          \"state\": \"Oost-Vlaanderen\",\n          \"country\": \"BE\",\n          \"description\": \"\"\n        },\n        \"note\": \"\",\n        \"date\": \"2024-08-20\",\n        \"reference_number\": \"\",\n        \"planning_instructions\": \"\",\n        \"email\": \"\",\n        \"phone_number\": \"\",\n        \"mobile_number\": \"\"\n      },\n      \"delivery_stop\": {\n        \"location\": {\n          \"name\": \"Qargo London\",\n          \"address\": \"71-91 Aldwych\",\n          \"postal_code\": \"WC2B 4HN\",\n          \"city\": \"London\",\n          \"country\": \"GB\",\n          \"description\": \"Delivery\"\n        },\n        \"note\": \"Delivery notes\",\n        \"date\": \"2024-08-22\",\n        \"reference_number\": \"\",\n        \"planning_instructions\": \"\",\n        \"email\": \"\",\n        \"phone_number\": \"\",\n        \"mobile_number\": \"\"\n      },\n      \"goods\": [\n        {\n          \"quantity\": 1,\n          \"packaging_type\": {\n            \"name\": \"Full Pallet\",\n            \"packaging_size\": { \"code\": \"FP\" }\n          },\n          \"handling_units\": [\n            { \"barcode\": { \"value\": \"01J93R8V517R7133FVCM3ZCJNN\" } }\n          ]\n        },\n        {\n          \"quantity\": 2,\n          \"packaging_type\": {\n            \"name\": \"Half Pallet\",\n            \"packaging_size\": { \"code\": \"HP\" }\n          },\n          \"handling_units\": [\n            { \"barcode\": { \"value\": \"01J93R9024CNTJJPQG8WDP2PVX\" } },\n            { \"barcode\": { \"value\": \"01J93R9PKY3A5C9S6T4VV12C8B\" } }\n          ]\n        }\n      ]\n    }\n  ],\n  \"customer_reference_number\": \"QARGO-0001\",\n  \"transport_service\": { \"code\": \"PALLETS\" },\n  \"service_level\": { \"code\": \"PREMIUM_NEXT_DAY\" }\n}\n"},"children":[]}]}]}],"sectionId":"/docs/section/transport-order-creation-and-status/order-with-pallets-and-custom-barcodes"}],"sectionId":"/docs/section/transport-order-creation-and-status/order-with-pallets-and-custom-barcodes"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/status-updates"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status updates"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API supports status updates for specific entities. This can either be via an endpoint or webhook."},"children":[]}]}]}]}],"sectionId":"/docs/section/status-updates"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/status-updates/task"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Task"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-task/update_task_status_v1_tasks_task__id__update_status_post"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" allows you to update the status of a task. A task in Qargo is linked to a side effect in an external system."},"children":[]}]}]}]}],"sectionId":"/docs/section/status-updates/task"}],"sectionId":"/docs/section/status-updates/task"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/status-updates/order"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can change the status of an order via the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/webhooks-inbound/order-import-webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-order/import_order_v1_orders_order_upload_post"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/docs/section/status-updates/order"}],"sectionId":"/docs/section/status-updates/order"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/status-updates/stop"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stop"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/webhooks-inbound/subcontractor-status-update-webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" allows you to either update:"},"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":"stops"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"stop groups"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using this "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/webhooks-inbound/subcontractor-status-update-webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you can provide status updates for stops or stop groups. You can also provide additional information in the payload"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"which can be mapped to different fields in Qargo."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status update date-time values, including "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eta_start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eta_end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", must include a timezone offset such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+02:00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/docs/section/status-updates/stop"}],"sectionId":"/docs/section/status-updates/stop"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/status-updates/booking"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Booking"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/webhooks-inbound/intermodal-booking-status-webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" allows an external intermodal booking system to report status updates for a booking, including its lifecycle status, execution statuses, and estimated and actual stop times."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date-time values must include a timezone offset such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+02:00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/docs/section/status-updates/booking"}],"sectionId":"/docs/section/status-updates/booking"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/visibility"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visibility"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We support visibility (sending messages triggered by Qargo system events) in the api as well."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These messages can be send out as a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/webhooks-outbound/operational_visibility_event_webhook_post"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or an EDI connection."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For most endpoints, visibility only trigger on status changes (for example, from stop "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN_PROGRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" -> "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are a few exceptions, these will be indicated in the overview:"},"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":"Order level"},"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":"We send out a visibility event on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCEPTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (order created), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REJECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (order skipped) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (all stops for order completed)."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stop level"},"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":"We send out a visibility event on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AT_STOP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (arrived at stop), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (all activities completed for stop)."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Position level (note: for every telematics update)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trip level"},"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":"We send a visibility event when a trip changes to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PLANNED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and when it transitions to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"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":"Resource level"},"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":"We send an event when a resource is assigned to a certain "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/section/concepts/trip"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"trip"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}]}],"sectionId":"/docs/section/visibility"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/accounting"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accounting"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following section details how to use our api for accounting integrations."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can push/pull accounting information between Qargo and the accounting system."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note that this is not suitable for BI/analytics purposes."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We offer a SQL based data warehouse connector to support this use case."},"children":[]}]}]}]}],"sectionId":"/docs/section/accounting"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/accounting/synchronize-invoicescredit-notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Synchronize invoices/credit notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flow for sales/purchase invoices and sales credit notes is the same, with a different payload."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We will show an example of syncing a sales invoices below"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We use a task oriented approach to indicate which invoice to sync (post in the accounting software)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The implementer should take the following steps:"},"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":"Fetch a list of available tasks (tasks in a TODO state)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For each available task:"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetch the payload in the task details"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sync the data to the accounting system."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report the status back, this result can be success or failure."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"image","inline":true,"attributes":{"alt":"Sync invoice/credit note flow","src":"https://api.qargo.com/docs/static/sync_invoice_flow.svg"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is allowed to only process a subset of the available tasks and process the remaining invoices later."},"children":[]}]}]}]}],"sectionId":"/docs/section/accounting/synchronize-invoicescredit-notes"}],"sectionId":"/docs/section/accounting/synchronize-invoicescredit-notes"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/accounting/example"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetch the Invoice/Credit notes to sync using "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-accounting/list_invoices_credit_notes_to_sync_v1_accounting_sync_tasks_get"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sync tasks endpoint"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl https://api.qargo.com/v1/accounting/sync-tasks -H 'Content-type: application/json' -H 'Authorization: Bearer *access_token*'\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl https://api.qargo.com/v1/accounting/sync-tasks -H 'Content-type: application/json' -H 'Authorization: Bearer *access_token*'\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{ \"tasks\": [{ \"id\": \"*id_of_first_task*\" }] }\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{ \"tasks\": [{ \"id\": \"*id_of_first_task*\" }] }\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that as long as an endpoint is not marked as completed/failed, it will still show up as an available POST task."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetch the first payload:"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"pre","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\ncurl https://api.qargo.com/v1/accounting/sync-tasks/*id_of_first_task* -H 'Content-type: application/json' -H 'Authorization: Bearer *access_token*'\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response:"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"pre","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n{\"id\": \""},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"id_of_first_task","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\", \"status\": \"TODO\", \"task_type\": \"POST_INVOICE\", \"payload\": {....}}\n"},"children":[]}]}]},{"$$mdtype":"Node","type":"comment","attributes":{"content":"Fetch the invoice document (when required).\n\n```\ncurl https://api.qargo.com/v1/documents/document/*id_of_document*/download -H 'Content-type: application/json' -H 'Authorization: Bearer *access_token*' -O\n```\n\nResponse:\n\n```\n* Document content *\n```\n\nComplete the first task:\n\n```\ncurl -X POST https://api.qargo.com/v1/accounting/sync-tasks/*id_of_first_task*/update-status -H 'Content-type: application/json' -H 'Authorization: Bearer *access_token*' -d '{\"status\": \"COMPLETED\"}'\n```\n\nResponse:\n\n```json\n{\"id\": \"<id_of_first_task>\", \"status\": \"COMPLETED\", \"task_type\": \"POST_INVOICE\"}\n```"},"children":[]}]}],"sectionId":"/docs/section/accounting/example"}],"sectionId":"/docs/section/accounting/example"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/accounting/fetch-updated-customer-information"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetch updated customer information"},"children":[]}]}]}]}],"sectionId":"/docs/section/accounting/fetch-updated-customer-information"}],"sectionId":"/docs/section/accounting/fetch-updated-customer-information"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/accounting/example"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl https://api.qargo.com/v1/company/*id_of_customer* -H 'Content-type: application/json' -H 'Authorization: Bearer *access_token*'\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl https://api.qargo.com/v1/company/*id_of_customer* -H 'Content-type: application/json' -H 'Authorization: Bearer *access_token*'\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\"id\": \"<id_of_customer>\", ...}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\"id\": \"<id_of_customer>\", ...}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: since we embed the customer/supplier company in the invoice payload, it is possible to synchronise these companies as part of the invoice posting flow."},"children":[]}]}]}]}],"sectionId":"/docs/section/accounting/example"}],"sectionId":"/docs/section/accounting/example"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/accounting/synchronize-blocked-status-of-customer"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Synchronize blocked status of customer"},"children":[]}]}]}]}],"sectionId":"/docs/section/accounting/synchronize-blocked-status-of-customer"}],"sectionId":"/docs/section/accounting/synchronize-blocked-status-of-customer"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/accounting/example"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update the customer blocked status:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -X POST https://api.qargo.com/v1/company/*id_of_customer* -H 'Content-type: application/json' -H 'Authorization: Bearer *access_token*' -d  '{\"is_blocked\": true}'\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -X POST https://api.qargo.com/v1/company/*id_of_customer* -H 'Content-type: application/json' -H 'Authorization: Bearer *access_token*' -d  '{\"is_blocked\": true}'\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\"id\": \"<id_of_customer>\", \"is_blocked\": true, ....}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\"id\": \"<id_of_customer>\", \"is_blocked\": true, ....}\n"},"children":[]}]}]}],"sectionId":"/docs/section/accounting/example"}],"sectionId":"/docs/section/accounting/example"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/accounting/creating-contacts-for-a-customer-or-subcontractor"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creating contacts for a customer or subcontractor"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can create a contact for a customer or subcontractor by providing a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contacts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" list in the payload."},"children":[]}]}]}]}],"sectionId":"/docs/section/accounting/creating-contacts-for-a-customer-or-subcontractor"}],"sectionId":"/docs/section/accounting/creating-contacts-for-a-customer-or-subcontractor"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/accounting/example"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -X PATCH https://api.qargo.com/v1/company/*id_of_customer* -H 'Content-type: application/json' -H 'Authorization: Bearer *access_token*' -d  '{\"contacts\":[{\"name\":\"Contact name\",\"note\":\"Notes on the contact\",\"phone_number\":\"+32456789016\",\"email\":\"hello@qargo.com\",\"roles\":[\"BILLING\",\"OPERATIONS\"]}]}'\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -X PATCH https://api.qargo.com/v1/company/*id_of_customer* -H 'Content-type: application/json' -H 'Authorization: Bearer *access_token*' -d  '{\"contacts\":[{\"name\":\"Contact name\",\"note\":\"Notes on the contact\",\"phone_number\":\"+32456789016\",\"email\":\"hello@qargo.com\",\"roles\":[\"BILLING\",\"OPERATIONS\"]}]}'\n"},"children":[]}]}]}],"sectionId":"/docs/section/accounting/example"}],"sectionId":"/docs/section/accounting/example"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/accounting/updating-contacts-for-a-customer-or-subcontractor"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updating contacts for a customer or subcontractor"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To update a contact, you need to provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the contact you want to update in the payload."},"children":[]}]}]}]}],"sectionId":"/docs/section/accounting/updating-contacts-for-a-customer-or-subcontractor"}],"sectionId":"/docs/section/accounting/updating-contacts-for-a-customer-or-subcontractor"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/accounting/example"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -X PATCH https://api.qargo.com/v1/company/*id_of_customer* -H 'Content-type: application/json' -H 'Authorization: Bearer *access_token*' -d  '{\"id\": \"3ba86d22-0183-4575-804d-60e0a6fa2f74\", \"contacts\":[{\"name\":\"Contact name\",\"note\":\"Notes on the contact\",\"phone_number\":\"+32456789016\",\"email\":\"hello@qargo.com\",\"roles\":[\"BILLING\",\"OPERATIONS\"]}]}'\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -X PATCH https://api.qargo.com/v1/company/*id_of_customer* -H 'Content-type: application/json' -H 'Authorization: Bearer *access_token*' -d  '{\"id\": \"3ba86d22-0183-4575-804d-60e0a6fa2f74\", \"contacts\":[{\"name\":\"Contact name\",\"note\":\"Notes on the contact\",\"phone_number\":\"+32456789016\",\"email\":\"hello@qargo.com\",\"roles\":[\"BILLING\",\"OPERATIONS\"]}]}'\n"},"children":[]}]}]}],"sectionId":"/docs/section/accounting/example"}],"sectionId":"/docs/section/accounting/example"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/accounting/archiving-a-contact-for-a-customer-or-subcontractor"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Archiving a contact for a customer or subcontractor"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To archive a contact, you need to provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_archived"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the payload along with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the contact you want to archive."},"children":[]}]}]}]}],"sectionId":"/docs/section/accounting/archiving-a-contact-for-a-customer-or-subcontractor"}],"sectionId":"/docs/section/accounting/archiving-a-contact-for-a-customer-or-subcontractor"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/accounting/example"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -X PATCH https://api.qargo.com/v1/company/*id_of_customer* -H 'Content-type: application/json' -H 'Authorization: Bearer *access_token*' -d  '{\"is_archived\": true, \"id\": \"3ba86d22-0183-4575-804d-60e0a6fa2f74\", \"contacts\":[{\"name\":\"Contact name\",\"note\":\"Notes on the contact\",\"phone_number\":\"+32456789016\",\"email\":\"hello@qargo.com\",\"roles\":[\"BILLING\",\"OPERATIONS\"]}]}'\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -X PATCH https://api.qargo.com/v1/company/*id_of_customer* -H 'Content-type: application/json' -H 'Authorization: Bearer *access_token*' -d  '{\"is_archived\": true, \"id\": \"3ba86d22-0183-4575-804d-60e0a6fa2f74\", \"contacts\":[{\"name\":\"Contact name\",\"note\":\"Notes on the contact\",\"phone_number\":\"+32456789016\",\"email\":\"hello@qargo.com\",\"roles\":[\"BILLING\",\"OPERATIONS\"]}]}'\n"},"children":[]}]}]}],"sectionId":"/docs/section/accounting/example"}],"sectionId":"/docs/section/accounting/example"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/resources"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resources"},"children":[]}]}]}]}],"sectionId":"/docs/section/resources"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/resources/resource-groups"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource groups"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource groups represent the depot or site a resource (vehicle, driver, trailer) is allocated to, and they determine where the resource appears on the planning board. Use the API to keep group allocations in sync when resources move between sites — for example from a telematics or fleet management system."},"children":[]}]}]}]}],"sectionId":"/docs/section/resources/resource-groups"}],"sectionId":"/docs/section/resources/resource-groups"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/resources/looking-up-resource-groups"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Looking up resource groups"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource group ids are specific to your environment. Use the lookup endpoint to find the id of the group you want to allocate to. Archived resource groups are not included."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"GET /resource_groups\n\n{\n  \"items\": [\n    { \"id\": \"7f0c1e2a-1111-4a6e-9c2b-3d5f8e7a9b01\", \"name\": \"Oswestry\", \"code\": \"OSW\" },\n    { \"id\": \"a4b8d990-2222-4c1f-8e3a-6b9d0c4e5f02\", \"name\": \"Leeds\", \"code\": \"LDS\" }\n  ],\n  \"next_cursor\": null\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET /resource_groups\n\n{\n  \"items\": [\n    { \"id\": \"7f0c1e2a-1111-4a6e-9c2b-3d5f8e7a9b01\", \"name\": \"Oswestry\", \"code\": \"OSW\" },\n    { \"id\": \"a4b8d990-2222-4c1f-8e3a-6b9d0c4e5f02\", \"name\": \"Leeds\", \"code\": \"LDS\" }\n  ],\n  \"next_cursor\": null\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lookups by name or code are not supported, since names and codes are not guaranteed to be unique."},"children":[]}]}]}]}],"sectionId":"/docs/section/resources/looking-up-resource-groups"}],"sectionId":"/docs/section/resources/looking-up-resource-groups"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/resources/reading-a-resource's-groups"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reading a resource's groups"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All resource read endpoints return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resource_groups"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the groups the resource is currently allocated to. This is a list — a resource can be allocated to more than one group at the same time (for example through rotating schedules). For most resources it contains a single element; it is empty when the resource is not in any group."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"GET /resource/{resource_id}\n\n{\n  \"id\": \"3f9e6b1c-3333-4d2e-b1a4-7c8f9e0a1b03\",\n  \"name\": \"Truck 142\",\n  \"resource_groups\": [\n    { \"id\": \"7f0c1e2a-1111-4a6e-9c2b-3d5f8e7a9b01\", \"name\": \"Oswestry\", \"code\": \"OSW\" }\n  ]\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET /resource/{resource_id}\n\n{\n  \"id\": \"3f9e6b1c-3333-4d2e-b1a4-7c8f9e0a1b03\",\n  \"name\": \"Truck 142\",\n  \"resource_groups\": [\n    { \"id\": \"7f0c1e2a-1111-4a6e-9c2b-3d5f8e7a9b01\", \"name\": \"Oswestry\", \"code\": \"OSW\" }\n  ]\n}\n"},"children":[]}]}]}],"sectionId":"/docs/section/resources/reading-a-resource's-groups"}],"sectionId":"/docs/section/resources/reading-a-resource's-groups"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/resources/updating-a-resource's-group"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updating a resource's group"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set the group with a PATCH on the resource, referencing the group by id. One resource per call — there is no bulk update."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"PATCH /resource/{resource_id}\n{ \"resource_group\": { \"id\": \"a4b8d990-2222-4c1f-8e3a-6b9d0c4e5f02\" } }\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PATCH /resource/{resource_id}\n{ \"resource_group\": { \"id\": \"a4b8d990-2222-4c1f-8e3a-6b9d0c4e5f02\" } }\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send an explicit "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to remove the resource from its group. Omitting the field leaves the allocation unchanged."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"PATCH /resource/{resource_id}\n{ \"resource_group\": null }\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PATCH /resource/{resource_id}\n{ \"resource_group\": null }\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the asymmetry: you set a single group, but read a list. The PATCH manages the resource's own (fixed) allocation; allocations coming from combinations of multiple resources or from rotating schedules are not affected by it and stay managed in the TMS UI."},"children":[]}]}]}]}],"sectionId":"/docs/section/resources/updating-a-resource's-group"}],"sectionId":"/docs/section/resources/updating-a-resource's-group"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/resources/errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Errors"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"HTTP 400\n{ \"message\": \"Resource group with id a4b8d990-2222-4c1f-8e3a-6b9d0c4e5f02 not found\" }\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"HTTP 400\n{ \"message\": \"Resource group with id a4b8d990-2222-4c1f-8e3a-6b9d0c4e5f02 not found\" }\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when the referenced group does not exist in your environment, or is archived."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Changing a group does not trigger notifications in Qargo and does not adjust planning rules or auto-assign logic tied to the previous group."},"children":[]}]}]}]}],"sectionId":"/docs/section/resources/errors"}],"sectionId":"/docs/section/resources/errors"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/resources/extras"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Extras"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resources can be associated with stop extras (e.g. ADR, taillift, temperature control) to indicate which extras the resource is compatible with. Extras are specific to your environment — use the TMS UI or ask your Qargo contact to find the codes available."},"children":[]}]}]}]}],"sectionId":"/docs/section/resources/extras"}],"sectionId":"/docs/section/resources/extras"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/resources/setting-extras-on-create"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Setting extras on create"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"extras"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the POST body to set extras when creating a resource."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"POST /resource\n{\n  \"resource_type\": \"TRACTOR\",\n  \"name\": \"Truck 01\",\n  \"extras\": [\n    { \"code\": \"ADR\" },\n    { \"code\": \"TAIL\" }\n  ]\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST /resource\n{\n  \"resource_type\": \"TRACTOR\",\n  \"name\": \"Truck 01\",\n  \"extras\": [\n    { \"code\": \"ADR\" },\n    { \"code\": \"TAIL\" }\n  ]\n}\n"},"children":[]}]}]}],"sectionId":"/docs/section/resources/setting-extras-on-create"}],"sectionId":"/docs/section/resources/setting-extras-on-create"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/resources/response-(all-read-endpoints)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response (all read endpoints)"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"extras\": [\n    { \"id\": \"uuid-1\", \"code\": \"ADR\", \"name\": \"ADR Transport\" },\n    { \"id\": \"uuid-2\", \"code\": \"TAIL\", \"name\": \"Taillift\" }\n  ]\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"extras\": [\n    { \"id\": \"uuid-1\", \"code\": \"ADR\", \"name\": \"ADR Transport\" },\n    { \"id\": \"uuid-2\", \"code\": \"TAIL\", \"name\": \"Taillift\" }\n  ]\n}\n"},"children":[]}]}]}],"sectionId":"/docs/section/resources/response-(all-read-endpoints)"}],"sectionId":"/docs/section/resources/response-(all-read-endpoints)"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/resources/updating-extras"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updating extras"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Providing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"extras"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" replaces the entire list. Omitting the field leaves existing extras untouched. Send an empty list to clear all extras."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"PATCH /resource/{resource_id}\n{ \"extras\": [{ \"code\": \"TAIL\" }] }\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PATCH /resource/{resource_id}\n{ \"extras\": [{ \"code\": \"TAIL\" }] }\n"},"children":[]}]}]}],"sectionId":"/docs/section/resources/updating-extras"}],"sectionId":"/docs/section/resources/updating-extras"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/resources/error-duplicate-code"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error — duplicate code"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a code matches more than one extra in the tenant, the API returns an error."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"HTTP 400\n{ \"message\": \"Multiple extras found with code 'TAIL'. Please ensure extra codes are unique, or contact support.\" }\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"HTTP 400\n{ \"message\": \"Multiple extras found with code 'TAIL'. Please ensure extra codes are unique, or contact support.\" }\n"},"children":[]}]}]}],"sectionId":"/docs/section/resources/error-duplicate-code"}],"sectionId":"/docs/section/resources/error-duplicate-code"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/resources/unavailabilities"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unavailabilities"},"children":[]}]}]}]}],"sectionId":"/docs/section/resources/unavailabilities"}],"sectionId":"/docs/section/resources/unavailabilities"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/resources/creating-a-unavailability"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creating a unavailability"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creating an unavailability is always for a single resource. Currently no bulk unavailability creation is supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"reason\": \"DRIVER_HOLIDAY\",\n  \"start_time\": \"2025-01-08T00:00:00+00:00\",\n  \"end_time\": \"2025-01-12T00:00:00+00:00\",\n  \"description\": \"HR reference HR00001\",\n  \"external_id\": \"YOUR_REFERENCE_00001\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"reason\": \"DRIVER_HOLIDAY\",\n  \"start_time\": \"2025-01-08T00:00:00+00:00\",\n  \"end_time\": \"2025-01-12T00:00:00+00:00\",\n  \"description\": \"HR reference HR00001\",\n  \"external_id\": \"YOUR_REFERENCE_00001\"\n}\n"},"children":[]}]}]}],"sectionId":"/docs/section/resources/creating-a-unavailability"}],"sectionId":"/docs/section/resources/creating-a-unavailability"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/resources/updating-an-unavailability"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updating an unavailability"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updating an unavailability is always for a single resource. Currently no bulk unavailability updates are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"reason\": \"DRIVER_HOLIDAY\",\n  \"start_time\": \"2025-01-09T00:00:00+00:00\",\n  \"end_time\": \"2025-01-12T00:00:00+00:00\",\n  \"description\": \"HR reference HR00002, correction 1 day\",\n  \"external_id\": \"YOUR_REFERENCE_00001\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"reason\": \"DRIVER_HOLIDAY\",\n  \"start_time\": \"2025-01-09T00:00:00+00:00\",\n  \"end_time\": \"2025-01-12T00:00:00+00:00\",\n  \"description\": \"HR reference HR00002, correction 1 day\",\n  \"external_id\": \"YOUR_REFERENCE_00001\"\n}\n"},"children":[]}]}]}],"sectionId":"/docs/section/resources/updating-an-unavailability"}],"sectionId":"/docs/section/resources/updating-an-unavailability"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/resources/deleting-an-unavailability"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deleting an unavailability"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deleting a unavailability will remove the unavailability from the system. This is not reversable."},"children":[]}]}]}]}],"sectionId":"/docs/section/resources/deleting-an-unavailability"}],"sectionId":"/docs/section/resources/deleting-an-unavailability"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/e-invoicing"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-invoicing"},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-invoicing refers to the automated, digital exchange of structured invoice data between businesses (e.g., suppliers and buyers) in a standardized format."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We support receiving purchase invoices and credit notes in multiple formats:"},"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":"JSON"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Qargo's own structured purchase invoice/credit note schema"},"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":"XML (UBL)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Peppol-compliant UBL documents"},"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":"Multipart"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — JSON data combined with file attachments (PDF, XML, etc.)"},"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":"Custom formats"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — CSV, EDIFACT, fixed-width, or other proprietary formats via the Qargo integration framework"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attachments (e.g. the invoice PDF, CMR documents) can be included either via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachments[].document"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object in JSON (with base64-encoded content), or as additional parts in a multipart upload."},"children":[]}]}]}]}],"sectionId":"/docs/section/e-invoicing"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/e-invoicing/peppol"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peppol"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information on Peppol E-invoicing, see https://help.qargo.com/en/articles/304774-invoices-peppol-in-qargo."},"children":[]}]}]}]}],"sectionId":"/docs/section/e-invoicing/peppol"}],"sectionId":"/docs/section/e-invoicing/peppol"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/e-invoicing/workflows"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Workflows"},"children":[]}]}]}]}],"sectionId":"/docs/section/e-invoicing/workflows"}],"sectionId":"/docs/section/e-invoicing/workflows"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/e-invoicing/importing-e-invoices-into-qargo-via-webhook"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Importing E-invoices into Qargo via webhook"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-e-invoicing/e-invoicing-webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" allows importing e-invoices into Qargo. The e-invoice can either be a purchase invoice or a purchase credit note. See the endpoint documentation for detailed format examples and attachment handling."},"children":[]}]}]}]}],"sectionId":"/docs/section/e-invoicing/importing-e-invoices-into-qargo-via-webhook"}],"sectionId":"/docs/section/e-invoicing/importing-e-invoices-into-qargo-via-webhook"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/question-paths-and-answers"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Question paths and answers"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Question paths are a configuration mechanism that maps fields in incoming data to specific fields, documents or actions in Qargo. A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"question_answers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" dict can be included on updates in two webhooks:"},"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":"link","inline":true,"attributes":{"href":"/docs/webhooks-inbound/subcontractor-status-update-webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status update"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — on stop or stop group updates"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/webhooks-inbound/partial-order-update"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partial order update"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — on order, consignment, stop, good, or handling unit updates"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The keys of this dict correspond to question paths configured on an integration; the values are the answers."},"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":"Status update example"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"updates\": [\n    {\n      \"event_time\": \"2024-08-20T10:00:00Z\",\n      \"stop\": {\n        \"id\": \"a2a84715-0027-49af-ad30-494c0ccf75cc\",\n        \"status\": \"COMPLETED\",\n        \"question_answers\": {\n          \"trailer_number\": \"VB-123-AB\"\n        }\n      }\n    }\n  ]\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"updates\": [\n    {\n      \"event_time\": \"2024-08-20T10:00:00Z\",\n      \"stop\": {\n        \"id\": \"a2a84715-0027-49af-ad30-494c0ccf75cc\",\n        \"status\": \"COMPLETED\",\n        \"question_answers\": {\n          \"trailer_number\": \"VB-123-AB\"\n        }\n      }\n    }\n  ]\n}\n"},"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":"Partial order update example"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"updates\": [\n    {\n      \"match\": {\n        \"matches_all\": [\n          {\n            \"order\": {\n              \"customer_reference_number\": { \"matches_any\": [\"T1234393\"] }\n            }\n          }\n        ]\n      },\n      \"consignment\": {\n        \"updates\": [\n          {\n            \"question_answers\": {\n              \"consignee_signature\": {\n                \"embedded_document\": {\n                  \"content\": \"IkhlbGxvLCB3b3JsZC4gSGVsbG8sIHdvcmxkLiBIZWxsbywgd29ybGQuIg==\",\n                  \"content_type\": \"image/svg+xml\",\n                  \"filename\": \"a_file_name.svg\"\n                }\n              }\n            },\n            \"good\": {\n              \"updates\": [\n                {\n                  \"handling_unit\": {\n                    \"updates\": [\n                      {\n                        \"match\": {\n                          \"matches_all\": [\n                            {\n                              \"handling_unit\": {\n                                \"barcode\": { \"matches_any\": [\"ABC123\"] }\n                              }\n                            }\n                          ]\n                        },\n                        \"question_answers\": {\n                          \"scan_barcode\": [\n                            {\n                              \"timestamp\": \"2024-08-20T10:00:00Z\",\n                              \"status\": \"DELIVERED\",\n                              \"stop_location_code\": \"DEPOT-001\",\n                              \"stop_match\": {\n                                \"location\": {\n                                  \"postal_code\": { \"matches_any\": [\"NW1 2AB\"] }\n                                }\n                              }\n                            }\n                          ]\n                        }\n                      }\n                    ]\n                  }\n                }\n              ]\n            }\n          }\n        ]\n      }\n    }\n  ]\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"updates\": [\n    {\n      \"match\": {\n        \"matches_all\": [\n          {\n            \"order\": {\n              \"customer_reference_number\": { \"matches_any\": [\"T1234393\"] }\n            }\n          }\n        ]\n      },\n      \"consignment\": {\n        \"updates\": [\n          {\n            \"question_answers\": {\n              \"consignee_signature\": {\n                \"embedded_document\": {\n                  \"content\": \"IkhlbGxvLCB3b3JsZC4gSGVsbG8sIHdvcmxkLiBIZWxsbywgd29ybGQuIg==\",\n                  \"content_type\": \"image/svg+xml\",\n                  \"filename\": \"a_file_name.svg\"\n                }\n              }\n            },\n            \"good\": {\n              \"updates\": [\n                {\n                  \"handling_unit\": {\n                    \"updates\": [\n                      {\n                        \"match\": {\n                          \"matches_all\": [\n                            {\n                              \"handling_unit\": {\n                                \"barcode\": { \"matches_any\": [\"ABC123\"] }\n                              }\n                            }\n                          ]\n                        },\n                        \"question_answers\": {\n                          \"scan_barcode\": [\n                            {\n                              \"timestamp\": \"2024-08-20T10:00:00Z\",\n                              \"status\": \"DELIVERED\",\n                              \"stop_location_code\": \"DEPOT-001\",\n                              \"stop_match\": {\n                                \"location\": {\n                                  \"postal_code\": { \"matches_any\": [\"NW1 2AB\"] }\n                                }\n                              }\n                            }\n                          ]\n                        }\n                      }\n                    ]\n                  }\n                }\n              ]\n            }\n          }\n        ]\n      }\n    }\n  ]\n}\n"},"children":[]}]}]}],"sectionId":"/docs/section/question-paths-and-answers"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/question-paths-and-answers/document-sync-via-question_paths"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document sync via question_paths"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds a document to its relevant subject (e.g. POD/CMR -> consignment). The document can either be embedded or referenced."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"remote_document"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"embedded_document"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be defined per document object."},"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":"Answer format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": JSON array of document objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"[\n  {\n    \"remote_document\": {\n      \"upload_id\": \"6f223c71-5758-4a31-b2e8-84ba91a90dd1\"\n    }\n  }\n]\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"[\n  {\n    \"remote_document\": {\n      \"upload_id\": \"6f223c71-5758-4a31-b2e8-84ba91a90dd1\"\n    }\n  }\n]\n"},"children":[]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"[\n  {\n    \"embedded_document\": {\n      \"content\": \"IkhlbGxvLCB3b3JsZC4gSGVsbG8sIHdvcmxkLiBIZWxsbywgd29ybGQuIg==\",\n      \"content_type\": \"image/png\",\n      \"filename\": \"a_file_name.png\"\n    }\n  }\n]\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"[\n  {\n    \"embedded_document\": {\n      \"content\": \"IkhlbGxvLCB3b3JsZC4gSGVsbG8sIHdvcmxkLiBIZWxsbywgd29ybGQuIg==\",\n      \"content_type\": \"image/png\",\n      \"filename\": \"a_file_name.png\"\n    }\n  }\n]\n"},"children":[]}]}]}],"sectionId":"/docs/section/question-paths-and-answers/document-sync-via-question_paths"}],"sectionId":"/docs/section/question-paths-and-answers/document-sync-via-question_paths"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/question-paths-and-answers/replacing-a-document"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replacing a document"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to give the document a stable identity in your own system. Sending a document again under an external id that was used before on the same subject replaces the earlier one: the new document is added and the one it supersedes is removed. This is how a regenerated document (e.g. a pallet label reprinted after the pallet count changed) is kept as a single document instead of accumulating versions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The external id must identify a single document. It is scoped to the subject the document is attached to, so the same value can be reused across orders, consignments or stops, but reusing one value for two documents on the same subject (e.g. a proof of delivery and a CMR) means the second one replaces the first."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"[\n  {\n    \"external_id\": \"LABEL-4471\",\n    \"embedded_document\": {\n      \"content\": \"IkhlbGxvLCB3b3JsZC4gSGVsbG8sIHdvcmxkLiBIZWxsbywgd29ybGQuIg==\",\n      \"content_type\": \"image/png\",\n      \"filename\": \"pallet_label.png\"\n    }\n  }\n]\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"[\n  {\n    \"external_id\": \"LABEL-4471\",\n    \"embedded_document\": {\n      \"content\": \"IkhlbGxvLCB3b3JsZC4gSGVsbG8sIHdvcmxkLiBIZWxsbywgd29ybGQuIg==\",\n      \"content_type\": \"image/png\",\n      \"filename\": \"pallet_label.png\"\n    }\n  }\n]\n"},"children":[]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"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":"code","inline":true,"attributes":{"content":"remote_document"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"object"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object with upload id of uploaded document"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"embedded_document"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"object"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document info with base64 encoded document"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the document in your system, used to replace it"},"children":[]}]}]}]}]}]}]}],"sectionId":"/docs/section/question-paths-and-answers/replacing-a-document"}],"sectionId":"/docs/section/question-paths-and-answers/replacing-a-document"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"section/question-paths-and-answers/remote_document"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"remote_document"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"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":"code","inline":true,"attributes":{"content":"upload_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UUID"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload id of document, received from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/document/upload_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint"},"children":[]}]}]}]}]}]}]}],"sectionId":"/docs/section/question-paths-and-answers/remote_document"}],"sectionId":"/docs/section/question-paths-and-answers/remote_document"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"section/question-paths-and-answers/embedded_document"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"embedded_document"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"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":"code","inline":true,"attributes":{"content":"content"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base64 encoded document"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","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":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The content type of the embedded document"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filename"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The filename of the embedded document"},"children":[]}]}]}]}]}]}]}],"sectionId":"/docs/section/question-paths-and-answers/embedded_document"}],"sectionId":"/docs/section/question-paths-and-answers/embedded_document"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/question-paths-and-answers/actions"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Actions"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apart from updating fields and documents, question paths can be configured to trigger one of the following actions."},"children":[]}]}]}]}],"sectionId":"/docs/section/question-paths-and-answers/actions"}],"sectionId":"/docs/section/question-paths-and-answers/actions"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/question-paths-and-answers/assign_resource"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"assign_resource"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Assigns a resource (trailer, container, or full trailer) to an order or trip based on a plain-text identifier."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no matching resource is found the answer is silently ignored."},"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":"Answer format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": plain string — the resource's name, code, licence plate, or container number."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"VB-123-AB\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"VB-123-AB\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Matching strips all non-alphanumeric characters and is case-insensitive, so "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VB-123-AB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VB 123 AB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VB123AB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" all resolve to the same resource."},"children":[]}]}]}]}],"sectionId":"/docs/section/question-paths-and-answers/assign_resource"}],"sectionId":"/docs/section/question-paths-and-answers/assign_resource"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/question-paths-and-answers/scan_barcode"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scan_barcode"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Records a barcode scan event on a handling unit. An optional stop match is provided, which if matched will record which stop the scan is related to alongside the scan. If the stop is not matched the scan will still succeed, but the stop will not be recorded."},"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":"Answer format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": JSON array of scan objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"[\n  {\n    \"timestamp\": \"2024-08-20T10:00:00Z\",\n    \"status\": \"SCANNED_IN\",\n    \"stop_location_code\": \"DEPOT-001\",\n    \"stop_match\": {\n      \"location\": {\n        \"postal_code\": { \"matches_any\": [\"NW1 2AB\"] }\n      }\n    }\n  }\n]\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"[\n  {\n    \"timestamp\": \"2024-08-20T10:00:00Z\",\n    \"status\": \"SCANNED_IN\",\n    \"stop_location_code\": \"DEPOT-001\",\n    \"stop_match\": {\n      \"location\": {\n        \"postal_code\": { \"matches_any\": [\"NW1 2AB\"] }\n      }\n    }\n  }\n]\n"},"children":[]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"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":"code","inline":true,"attributes":{"content":"timestamp"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 8601 datetime"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time of the scan event"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scan status (see below)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"barcode"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Barcode value; used to identify the handling unit. Optional as the unit will have been matched in the partial order update."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop_match"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"object"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria for matching the scan to a specific stop on the trip (see below)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop_location_code"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Location identifier code"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Free-text description"},"children":[]}]}]}]}]}]}]}],"sectionId":"/docs/section/question-paths-and-answers/scan_barcode"}],"sectionId":"/docs/section/question-paths-and-answers/scan_barcode"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"section/question-paths-and-answers/stop_match"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop_match"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"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":"code","inline":true,"attributes":{"content":"stop_type"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of stop to match: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PICKUP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELIVERY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEPOT_UNLOAD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEPOT_LOAD"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"object"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Match by stop ID: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ \"matches_any\": [\"<id>\"] }"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference_number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"object"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Match by stop reference number: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ \"matches_any\": [\"<reference>\"] }"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"location"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"object"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Match by the stop's location (see below)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"leg"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"object"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Match by the leg (stage) the stop bounds (see below)"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A depot is modelled as two stops: the goods are unloaded off the inbound leg ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEPOT_UNLOAD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"later loaded onto the outbound leg ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEPOT_LOAD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Direct consignments have no depot stops, so"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"neither depot stop type matches anything there — use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PICKUP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELIVERY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"From three legs onwards each depot stop type occurs more than once per consignment, so "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop_type"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"alone is ambiguous and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"leg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be supplied as well. Ambiguous matches are not resolved by"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"guessing: the scan is left unlinked (or the update rejected) instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scan"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop_type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"leg.leg_type"},"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":"code","inline":true,"attributes":{"content":"COLLECTION_DEPOT_SCANNED_IN"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEPOT_UNLOAD"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PICKUP"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COLLECTION_DEPOT_SCANNED_OUT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEPOT_LOAD"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (2 legs: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELIVERY"},"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":"code","inline":true,"attributes":{"content":"DELIVERY_DEPOT_SCANNED_IN"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEPOT_UNLOAD"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (2 legs: n/a)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELIVERY_DEPOT_SCANNED_OUT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEPOT_LOAD"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELIVERY"},"children":[]}]}]}]}]}]}]}],"sectionId":"/docs/section/question-paths-and-answers/stop_match"}],"sectionId":"/docs/section/question-paths-and-answers/stop_match"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"section/question-paths-and-answers/stop_match.leg"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop_match.leg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"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":"code","inline":true,"attributes":{"content":"leg_type"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of leg the stop bounds: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PICKUP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELIVERY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DIRECT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EMPTY"},"children":[]}]}]}]}]}]}]}],"sectionId":"/docs/section/question-paths-and-answers/stop_match.leg"}],"sectionId":"/docs/section/question-paths-and-answers/stop_match.leg"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"section/question-paths-and-answers/stop_match.location"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop_match.location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"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":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"object"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Match by location ID: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ \"matches_any\": [\"<id>\"] }"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"object"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Match by location name: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ \"matches_any\": [\"<name>\"] }"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"postal_code"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"object"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Match by postal code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ \"matches_any\": [\"<postal_code>\"] }"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"country_code"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"object"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Match by country code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ \"matches_any\": [\"<country_code>\"] }"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available status values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"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":"code","inline":true,"attributes":{"content":"SCANNED_IN"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Handling unit has been scanned in at a pickup stop or at a depot"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STORED"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Handling unit is in storage at a depot"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SCANNED_OUT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Handling unit has been scanned out of a depot or at a delivery stop"},"children":[]}]}]}]}]}]}]}],"sectionId":"/docs/section/question-paths-and-answers/stop_match.location"}],"sectionId":"/docs/section/question-paths-and-answers/stop_match.location"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/mcp"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MCP"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Qargo MCP server lets an AI assistant call the Qargo API on behalf of a signed-in user, using the Model Context Protocol."},"children":[]}]}]}]}],"sectionId":"/docs/section/mcp"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/mcp/what-it-is"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What it is"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MCP is an open standard for connecting AI assistants to external systems. The Qargo MCP server implements it as a thin layer over this API. It exposes no separate data model, and every call it makes is an ordinary API call, subject to the same "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/section/authentication"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/section/rate-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as any other."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use it when an assistant should answer questions about live tenant data, or perform routine changes under human supervision. Use the REST API directly for integrations, scheduled jobs, and anything needing deterministic behaviour."},"children":[]}]}]}]}],"sectionId":"/docs/section/mcp/what-it-is"}],"sectionId":"/docs/section/mcp/what-it-is"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/mcp/endpoint"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoint"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The server is at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://mcp.qargo.com/mcp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and appears in the client as "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Qargo"},"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":"Transport is MCP over streamable HTTP. Server-sent events are not supported."},"children":[]}]}]}]}],"sectionId":"/docs/section/mcp/endpoint"}],"sectionId":"/docs/section/mcp/endpoint"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/mcp/not-the-same-as-the-documentation-mcp"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not the same as the documentation MCP"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This site also publishes a documentation MCP server, offered through the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Connect to Cursor"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Connect to VS Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" buttons at the top of each page. That server reads this API reference and nothing else. It has no access to tenant data and no relationship to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mcp.qargo.com"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/docs/section/mcp/not-the-same-as-the-documentation-mcp"}],"sectionId":"/docs/section/mcp/not-the-same-as-the-documentation-mcp"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/mcp/prerequisites"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prerequisites"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three conditions must be met before a connection succeeds."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requirement"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scope"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set by"},"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":"text","inline":true,"attributes":{"content":"Qargo Intelligence"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tenant"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Qargo"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"External API access"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tenant"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Qargo"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MCP access, read-only or read and write"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Individual user, per tenant"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Qargo"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MCP access defaults to disabled for every user. Enabling Qargo Intelligence on a tenant grants it to nobody."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For access requests, please contact us at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"mailto:integrations@qargo.com"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integrations@qargo.com"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/docs/section/mcp/prerequisites"}],"sectionId":"/docs/section/mcp/prerequisites"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/mcp/connecting"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Connecting"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorisation uses OAuth 2.1 with PKCE and dynamic client registration, so a compliant client needs no Qargo-specific configuration."},"children":[]}]}]}]}],"sectionId":"/docs/section/mcp/connecting"}],"sectionId":"/docs/section/mcp/connecting"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/mcp/flow"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flow"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Point the client at the endpoint with no credentials. It discovers the authorisation server, registers itself, and opens a browser. The user signs in to Qargo, the browser returns an authorisation code, and the client exchanges it for tokens."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"mcpServers\": {\n    \"qargo\": {\n      \"type\": \"http\",\n      \"url\": \"https://mcp.qargo.com/mcp\"\n    }\n  }\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"mcpServers\": {\n    \"qargo\": {\n      \"type\": \"http\",\n      \"url\": \"https://mcp.qargo.com/mcp\"\n    }\n  }\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Clients that expose a connector UI rather than a config file need only the URL."},"children":[]}]}]}]}],"sectionId":"/docs/section/mcp/flow"}],"sectionId":"/docs/section/mcp/flow"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/mcp/authorisation-server-details"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorisation server details"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most clients discover these automatically. They are documented for clients that ask for them explicitly."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Setting"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"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":"text","inline":true,"attributes":{"content":"Discovery"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://oauth.qargo.com/.well-known/oauth-authorization-server"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization endpoint"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://oauth.qargo.com/authorize"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token endpoint"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://oauth.qargo.com/token"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PKCE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"S256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"plain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is rejected"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"None. Public clients only"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client registration"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dynamic only, per RFC 7591"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scopes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not used. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is ignored"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refresh"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type=refresh_token"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Clients requiring a pre-issued "},"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":" cannot connect, because Qargo issues neither. This rules out platforms whose configuration form demands static client credentials, including Gemini Enterprise."},"children":[]}]}]}]}],"sectionId":"/docs/section/mcp/authorisation-server-details"}],"sectionId":"/docs/section/mcp/authorisation-server-details"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/mcp/token-model"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token model"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token the client holds identifies the user but carries no tenant claims. It can do nothing except list the tenants that user can reach. Every tenant-scoped call triggers a server-side exchange for a token carrying the user's Qargo role in that tenant."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lifetime"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"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":"text","inline":true,"attributes":{"content":"Client token"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 hour"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refreshable"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tenant token"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 hour"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minted per tenant on demand"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorisation is re-checked on every call and never cached, so revoking a user's MCP access takes effect on their next request."},"children":[]}]}]}]}],"sectionId":"/docs/section/mcp/token-model"}],"sectionId":"/docs/section/mcp/token-model"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/mcp/sessions"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sessions"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sessions expire and require the user to sign in again, in practice about once a day. Expect re-authentication rather than treating it as an error."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Clients must send a stable "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Mcp-Session-Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header across a conversation. Production write approval is keyed on it, so a client that omits it or rotates it per request cannot complete a write. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/section/mcp/limits-and-safeguards"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"limits and safeguards"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the approval flow."},"children":[]}]}]}]}],"sectionId":"/docs/section/mcp/sessions"}],"sectionId":"/docs/section/mcp/sessions"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/mcp/client-setup"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client setup"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any MCP client supporting streamable HTTP and dynamic client registration can connect. Configuration for the clients Qargo tests against follows."},"children":[]}]}]}]}],"sectionId":"/docs/section/mcp/client-setup"}],"sectionId":"/docs/section/mcp/client-setup"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/mcp/claude-desktop-and-claude.ai"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Claude Desktop and claude.ai"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add a custom connector under "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settings > Connectors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the address "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://mcp.qargo.com/mcp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Authorisation opens in a browser on first use."},"children":[]}]}]}]}],"sectionId":"/docs/section/mcp/claude-desktop-and-claude.ai"}],"sectionId":"/docs/section/mcp/claude-desktop-and-claude.ai"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/mcp/claude-code"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Claude Code"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"claude mcp add --transport http qargo https://mcp.qargo.com/mcp\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"claude mcp add --transport http qargo https://mcp.qargo.com/mcp\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Then run "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/mcp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and select "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"qargo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to authenticate. Tokens are stored per project unless the server is registered globally."},"children":[]}]}]}]}],"sectionId":"/docs/section/mcp/claude-code"}],"sectionId":"/docs/section/mcp/claude-code"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/mcp/chatgpt"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ChatGPT"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom MCP connectors sit behind developer mode, on paid plans only. In Business, Enterprise and Education workspaces a workspace owner creates and publishes the app, and members cannot add it themselves. On Plus and Pro, an individual user adds it directly. Either way each user authenticates separately, so each gets their own Qargo permissions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enter the endpoint and select OAuth. Leave client ID and secret empty, since dynamic registration covers them."},"children":[]}]}]}]}],"sectionId":"/docs/section/mcp/chatgpt"}],"sectionId":"/docs/section/mcp/chatgpt"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/mcp/gemini"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gemini"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gemini Enterprise is not supported. It requires a static "},"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":" in its custom MCP server configuration, and it requires a scope list. Qargo issues no client credentials and ignores the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter. The consumer Gemini app has no custom MCP server option at all."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gemini CLI can connect, because it supports dynamic discovery:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"mcpServers\": {\n    \"qargo\": {\n      \"httpUrl\": \"https://mcp.qargo.com/mcp\"\n    }\n  }\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"mcpServers\": {\n    \"qargo\": {\n      \"httpUrl\": \"https://mcp.qargo.com/mcp\"\n    }\n  }\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Run "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/mcp auth qargo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to authenticate. OAuth requires a local browser and does not work over SSH."},"children":[]}]}]}]}],"sectionId":"/docs/section/mcp/gemini"}],"sectionId":"/docs/section/mcp/gemini"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/mcp/other-clients"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Other clients"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A client works if it supports streamable HTTP, PKCE with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"S256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", dynamic client registration, and a stable "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Mcp-Session-Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Test with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tools/list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before assuming write support."},"children":[]}]}]}]}],"sectionId":"/docs/section/mcp/other-clients"}],"sectionId":"/docs/section/mcp/other-clients"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/mcp/tools-and-access-levels"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tools and access levels"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The server exposes six generic tools rather than one tool per endpoint. Assistants discover operations at runtime from the OpenAPI description."},"children":[]}]}]}]}],"sectionId":"/docs/section/mcp/tools-and-access-levels"}],"sectionId":"/docs/section/mcp/tools-and-access-levels"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/mcp/tools"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tools"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tool"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"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":"code","inline":true,"attributes":{"content":"list_tenants"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists the tenants the caller can access, with their role in each. Available even with no access granted."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"get_tenant_details"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns identity, locale and billing address details for one tenant."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_api_discover"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists available operations, filterable by domain, method or free text."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_api_schema"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the full request and response schema for one "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"operationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with references resolved inline."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_api_call"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Executes an operation by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"operationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with path parameters, query parameters and a JSON body."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"request_upload"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a presigned URL and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"file_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a file to be attached to a later call."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every tenant-scoped tool accepts "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tenant_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tenant_slug"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Provide exactly one."},"children":[]}]}]}]}],"sectionId":"/docs/section/mcp/tools"}],"sectionId":"/docs/section/mcp/tools"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/mcp/tool-annotations"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tool annotations"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every tool carries MCP annotations, which clients use to decide when to prompt the user."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Annotation"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applied to"},"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":"code","inline":true,"attributes":{"content":"readOnlyHint: true"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All read operations. Most clients execute these without asking."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"destructiveHint: false"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ordinary writes. Qargo write approval still applies."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"destructiveHint: true"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_api_call"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and integration actions."},"children":[]}]}]}]}]}]}]}],"sectionId":"/docs/section/mcp/tool-annotations"}],"sectionId":"/docs/section/mcp/tool-annotations"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/mcp/operation-allowlist"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operation allowlist"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_api_discover"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_api_call"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are restricted to an allowlist of approved operations. Anything outside it is neither listed nor callable."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operations"},"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":"text","inline":true,"attributes":{"content":"Accounting"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"33"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"17"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"14"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"7"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Task"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trip"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identity"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated endpoints, webhook receivers and dispatch, authentication token generation, and webhook test utilities are excluded by design."},"children":[]}]}]}]}],"sectionId":"/docs/section/mcp/operation-allowlist"}],"sectionId":"/docs/section/mcp/operation-allowlist"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/mcp/access-levels"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access levels"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access is a server-side property of the user, not an OAuth scope. Clients request nothing and cannot influence it."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Level"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Grants"},"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":"text","inline":true,"attributes":{"content":"Disabled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No tools. The default for every user."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Read-only"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every read-only operation."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Read and write"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reads, plus every write and destructive operation."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Write access alone is not offered. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_api_call"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resolves each operation through a read-scoped client first, so a write-only user could not call it."},"children":[]}]}]}]}],"sectionId":"/docs/section/mcp/access-levels"}],"sectionId":"/docs/section/mcp/access-levels"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/mcp/errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Errors"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Class"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What the assistant receives"},"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":"text","inline":true,"attributes":{"content":"Tool error"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specific message plus a hint naming the next tool to call. Covers bad input, missing records, wrong tenant and insufficient access."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Write protection error"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An approval URL and instructions to retry after approval."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A generic message only. Details are not exposed."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the underlying API is returned as information, not as a failure."},"children":[]}]}]}]}],"sectionId":"/docs/section/mcp/errors"}],"sectionId":"/docs/section/mcp/errors"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/mcp/limits-and-safeguards"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limits and safeguards"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Calls made through MCP are ordinary API calls, so the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/section/rate-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" apply unchanged. Additional constraints exist because the caller is an assistant rather than an application."},"children":[]}]}]}]}],"sectionId":"/docs/section/mcp/limits-and-safeguards"}],"sectionId":"/docs/section/mcp/limits-and-safeguards"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/mcp/production-write-protection"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production write protection"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Writing to a production tenant requires explicit human approval before the first change in a session. The tool returns an approval URL:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"https://app.qargo.com/<tenant_slug>/mcp/write-protection?sessionId=<id>&ttl=<minutes>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"https://app.qargo.com/<tenant_slug>/mcp/write-protection?sessionId=<id>&ttl=<minutes>\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user opens it, approves, and asks the assistant to retry. Approval is scoped to the user, the tenant and the assistant session together, so a new session requires a new approval."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Two conditions must hold. The user must open the link in a browser already signed in to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"app.qargo.com"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and the client must send a stable "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Mcp-Session-Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If the approval store is unavailable, production writes are refused. Reads are unaffected."},"children":[]}]}]}]}],"sectionId":"/docs/section/mcp/production-write-protection"}],"sectionId":"/docs/section/mcp/production-write-protection"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/mcp/rate-limits"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limits"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limits are enforced per tenant on the credential, not per user, and are shared with any other API traffic that tenant generates. Exceeding them returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429 Too Many Requests"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/section/rate-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for current figures."},"children":[]}]}]}]}],"sectionId":"/docs/section/mcp/rate-limits"}],"sectionId":"/docs/section/mcp/rate-limits"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/mcp/response-size-and-pagination"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response size and pagination"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Constraint"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behaviour"},"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":"text","inline":true,"attributes":{"content":"List results"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Capped at 50 records per call, with a pagination hint in the response"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response size"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payloads above the response budget are written to temporary storage and returned as a signed URL rather than inline"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File uploads"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Two-step through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"request_upload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", 20 MB maximum. Tools never receive file bytes directly."},"children":[]}]}]}]}]}]}]}],"sectionId":"/docs/section/mcp/response-size-and-pagination"}],"sectionId":"/docs/section/mcp/response-size-and-pagination"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/mcp/what-is-out-of-scope"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What is out of scope"},"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":"Aggregated reporting, analytics and dashboard generation. Use the API directly, or the SQL based data warehouse connector."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tenant configuration, feature flags and integration setup."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any operation absent from the allowlist."},"children":[]}]}]}]}]}],"sectionId":"/docs/section/mcp/what-is-out-of-scope"}],"sectionId":"/docs/section/mcp/what-is-out-of-scope"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/mcp/operational-guidance"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operational guidance"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Assistants are non-deterministic. Treat MCP as a supervised interface, not an unattended one:"},"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":"Grant read-only by default, and read and write only where a change workflow requires it."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Review changes before approving a write session, particularly any change affecting more than one record."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prefer the REST API for anything scheduled, repeated or business critical."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For any questions about these limits, please contact us at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"mailto:integrations@qargo.com"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integrations@qargo.com"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/docs/section/mcp/operational-guidance"}],"sectionId":"/docs/section/mcp/operational-guidance"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/changelog"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Changelog"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recent additions and changes to the API, newest first."},"children":[]}]}]}]}],"sectionId":"/docs/section/changelog"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-09-04"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-09-04"},"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":"API"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Good schemas gain an optional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hs_codes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object on order create and order read, carrying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the number of HS codes for the good, used for customs rate calculation."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order"},"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":"Webhooks"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GoodData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GoodUpdateData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" gain an optional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hs_codes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object on the partial order update webhook (creating and updating a good), carrying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the number of HS codes for the good, used for customs rate calculation."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/webhooks-inbound/partial-order-update"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST /v1/webhook/partial-order-update"},"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":"Outgoing data"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Goods in outbound order payloads — operational visibility, fleet and subcontractor dispatch, intermodal and location bookings — gain an optional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hs_codes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object, carrying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the number of HS codes for the good. The field is omitted when not set on the good."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-customer-portal"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-fleet-dispatch"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fleet dispatch"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-intermodal-partner"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Intermodal"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-location-booking"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Location booking"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-subcontractor-dispatch"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subcontractor dispatch"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-visibility"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visibility"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-09-04"}],"sectionId":"/docs/section/changelog/2026-09-04"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-09-01"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-09-01"},"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":"API"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Packaged items gain an optional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"waste"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object and goods gain "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"waste_category"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", for cargo classified under the European Waste Catalogue. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"waste"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ewc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code with its hazard flag and localized description, plus "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consistency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"persistent_organic_pollutants"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processing_operation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"emitter_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Available on order upload, partial order update and in order responses."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-09-01"}],"sectionId":"/docs/section/changelog/2026-09-01"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-08-28"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-08-28"},"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":"API"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BarcodeSource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" gains "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PALLETLINE_OPTIMA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", identifying barcodes originating from the APC and Palletline Optima network integrations. Treat the barcode source as an open set and ignore values you do not recognise rather than rejecting the order."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-08-28"}],"sectionId":"/docs/section/changelog/2026-08-28"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-08-26"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-08-26"},"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":"API"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Stop extras accept a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object on order upload, matching order- and good-level extras."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Consignment.tracking_link"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is now returned on order responses: the public tracking page URL for each consignment. It is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the consignment has no tracking link, for example when the tracking link integration is not enabled on the tenant or the link has been revoked."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-order/get_order_details_v1_orders_order__order_id__get"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET /v1/orders/order/{order_id}"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-order/order_status_v1_orders_order__order_id__status_get"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET /v1/orders/order/{order_id}/status"},"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":"Webhooks"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TrackingUpdateData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" gains an optional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"voltage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object, carrying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_power_supply_voltage_mv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the external supply voltage of a unit in millivolts. Report the voltage of the external power line rather than the internal battery, so that a unit running on its own battery reports a value at or near zero. This lets Qargo derive whether a temperature-controlled unit is plugged in to external power."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-tracking"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tracking"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/webhooks-inbound/tracking-update"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST /v1/webhook/tracking-update"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-08-26"}],"sectionId":"/docs/section/changelog/2026-08-26"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-08-24"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-08-24"},"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":"Webhooks"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PackagedItemInput.barcodes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" accepts a list of barcode strings on packaged items, matching the existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"packaged_items[].barcodes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field on order upload. Previously the partial order update dropped the field."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/webhooks-inbound/partial-order-update"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST /v1/webhook/partial-order-update"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-08-24"}],"sectionId":"/docs/section/changelog/2026-08-24"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-08-19"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-08-19"},"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":"API"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PaymentTermCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" gains "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"END_OF_MONTH_0_NET_20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", for a payment term of end of this month plus 20 days."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-accounting"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accounting"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-company"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-task"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Task"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-trip"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trip"},"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":"Webhooks"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Stop matching now reaches depot stops. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"StopMatch.stop_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" accepts "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEPOT_UNLOAD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEPOT_LOAD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and the new "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"StopMatch.leg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object narrows a match to the leg a stop bounds via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"leg_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PICKUP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELIVERY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DIRECT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EMPTY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). From three legs onwards each depot stop type occurs more than once per consignment, so "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"leg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be supplied alongside "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; ambiguous matches are left unresolved rather than guessed."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-fleet-dispatch"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fleet dispatch"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-subcontractor-dispatch"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subcontractor dispatch"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/webhooks-inbound/fleet-status-update-webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST /v1/webhook/fleet-status-update"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/webhooks-inbound/partial-order-update"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST /v1/webhook/partial-order-update"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/webhooks-inbound/subcontractor-status-update-webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST /v1/webhook/subco-status-update"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-08-19"}],"sectionId":"/docs/section/changelog/2026-08-19"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-08-14"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-08-14"},"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":"API"},"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":"Fixed:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/me"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response now includes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active_tenant_slug"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for CUSTOMER-role tokens, matching other API roles."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/system"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"System"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /me"},"children":[]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-08-14"}],"sectionId":"/docs/section/changelog/2026-08-14"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-08-13"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-08-13"},"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":"Webhooks"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Document answers in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"question_answers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" now accept "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the document's identifier in your own system. A document sent again under an external id that was used before on the same order, consignment or stop replaces the earlier one instead of being added next to it. The identifier must point at a single document, not at the order or consignment it belongs to."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/webhooks-inbound/partial-order-update"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST /v1/webhook/partial-order-update"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-08-13"}],"sectionId":"/docs/section/changelog/2026-08-13"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-08-12"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-08-12"},"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":"API"},"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":"Changed:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Charge "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" now reports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVOICE_POSTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for charges on a posted invoice and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DO_NOT_INVOICE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for charges excluded from invoicing. These were previously reported as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CREATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", including on existing charges, so invoiced and uninvoiced charges can now be told apart. Treat the status as an open set and map unrecognised values to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CREATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-customer-portal"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v1/orders/order/{order_id}/charges"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v1/orders/order/{order_id}/charges/approval"},"children":[]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-08-12"}],"sectionId":"/docs/section/changelog/2026-08-12"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-08-11"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-08-11"},"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":"Outgoing data"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VisibilityOrderStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in operational visibility payloads gains "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BLOCKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", for an order that is blocked or on hold. Treat the order status as an open set and ignore values you do not recognise rather than rejecting the event."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-customer-portal"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-visibility"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visibility"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-08-11"}],"sectionId":"/docs/section/changelog/2026-08-11"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-08-10"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-08-10"},"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":"Webhooks"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Intermodal status updates now accept "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the booking's identifier in your own system. When supplied, it is stored as the identifier for the booking, taking precedence over "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"booking_reference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-intermodal-partner"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Intermodal"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/webhooks-inbound/intermodal-booking-status-webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST /v1/webhook/intermodal-status"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-08-10"}],"sectionId":"/docs/section/changelog/2026-08-10"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-08-06"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-08-06"},"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":"Webhooks"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The document-import webhook now accepts "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UK_EXPORTER_DRA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UK_IMPORTER_DRA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"document_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-document-import"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document import"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v1/webhook/document-import"},"children":[]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-08-06"}],"sectionId":"/docs/section/changelog/2026-08-06"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-08-05"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-08-05"},"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":"API"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The intermodal booking payload now includes a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object with the trip's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", so trip-level data (e.g. a customs procedure) can be used when dispatching bookings."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-intermodal-partner"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Intermodal"},"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":"Deprecated:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The root-level "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trip_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field on the intermodal booking payload is deprecated; use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trip.name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-intermodal-partner"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Intermodal"},"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":"Fixed:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Deleting a resource unavailability that is already deleted now reliably returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"204"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the request no longer fails with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the unavailability is gone."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-resource"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE /v1/resources/resource/{resource_id}/unavailability/{id}"},"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":"Outgoing data"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ResourceType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in operational visibility payloads gains "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HANDLING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", for handling equipment such as a forklift assigned to a stop, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUBCONTRACTOR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which the payload has been able to carry for some time but was undocumented. Treat the resource type as an open set and ignore values you do not recognise rather than rejecting the event."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-customer-portal"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-visibility"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visibility"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-08-05"}],"sectionId":"/docs/section/changelog/2026-08-05"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-08-03"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-08-03"},"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":"API"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pricing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" now includes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"by_currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", holding the pricing totals per currency keyed by currency code. Each entry covers only the charges in that currency, so an order charged in more than one currency reports a correct total per currency."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-order/get_order_details_v1_orders_order__order_id__get"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET /v1/orders/order/{order_id}"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-order/order_status_v1_orders_order__order_id__status_get"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET /v1/orders/order/{order_id}/status"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-08-03"}],"sectionId":"/docs/section/changelog/2026-08-03"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-07-31"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-07-31"},"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":"API"},"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":"Fixed:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Deleting a resource unavailability that is already deleted now returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"204"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead of failing with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", so a retried delete no longer has to be special-cased. Updating an unavailability that does not exist now returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" naming the id, instead of a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" reporting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Instance matching query does not exist"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-resource"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT /v1/resources/resource/{resource_id}/unavailability/{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE /v1/resources/resource/{resource_id}/unavailability/{id}"},"children":[]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-07-31"}],"sectionId":"/docs/section/changelog/2026-07-31"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-07-29"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-07-29"},"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":"API"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Master data can now be looked up by filter instead of by paging through the full list. Companies accept "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accounting_customer_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and accounts, tax rates and resource groups accept "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Every filter also has a batch form taking a comma-separated list, spelled "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code:in=A,B"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; the existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from_currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"to_currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filters on exchange rates gain the same batch form. The exact and the batch spelling of the same filter cannot be combined, and a batch list accepts at most 100 values. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accounting_customer_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" holds the code of the default billing entity."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-accounting"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accounting"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-company"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-resource"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v1/accounting/accounts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v1/accounting/company"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v1/accounting/exchange-rate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v1/accounting/tax-rates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v1/companies/company"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v1/resources/resource_groups"},"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":"Fixed:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Following "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on a filtered list request now keeps the filters applied. The second and later pages previously returned the full unfiltered list."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-accounting"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accounting"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-company"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-resource"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v1/accounting/company"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v1/accounting/exchange-rate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v1/companies/company"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v1/resources/resource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v1/resources/resource_groups"},"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":"Changed:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" An invalid value in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_id:in"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resource_type:in"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is now reported as a validation error (422) rather than a bad request (400), matching how an invalid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resource_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is already reported. An empty list such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_id:in="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is rejected as a bad request (400) instead of silently matching nothing, and a list accepts at most 100 values."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-resource"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v1/resources/resource"},"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":"Outgoing data"},"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":"Changed:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"location.name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is no longer guaranteed in operational visibility payloads. A location without a name, such as an address-only one created automatically by an order import, previously blocked the entire visibility event from being sent; it is now sent with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" omitted. Treat the field as optional and fall back to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"city"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when it is absent."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-customer-portal"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-visibility"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visibility"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-07-29"}],"sectionId":"/docs/section/changelog/2026-07-29"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-07-24"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-07-24"},"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":"Webhooks"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Consignment updates now support "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCEL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNCANCEL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operations. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCEL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" moves a consignment to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCELLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and takes its stops off the active route while keeping the record for invoicing and audit, unlike "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which removes it entirely. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNCANCEL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" reverts a cancelled consignment to a plannable state. Both require a consignment match, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNCANCEL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applies only to a consignment that is currently cancelled."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/webhooks-inbound/partial-order-update"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST /v1/webhook/partial-order-update"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-07-24"}],"sectionId":"/docs/section/changelog/2026-07-24"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-07-23"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-07-23"},"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":"API"},"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":"Fixed:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Updating a resource no longer returns a server error when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"note"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is omitted; the value is now stored as an empty string, matching create. Sending an explicit "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"note"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"locale"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is now rejected with a validation error (422) instead of failing with a server error on update, or being silently ignored on create."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-resource"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v1/resources/resource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT /v1/resources/resource/{resource_id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH /v1/resources/resource/{resource_id}"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Stops in order status responses now include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", identifying the consignment pickup ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PICKUP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and delivery ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELIVERY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") stops. The field is empty for other stops."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v1/orders/order/{order_id}/status"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resource_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can now be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BARGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AIRPLANE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", used by the resources that barge and air intermodal connections create."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Order, Resource, Trip"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-order/order_status_v1_orders_order__order_id__status_get"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET /v1/orders/order/{order_id}/status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v1/resources/resource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-trip/get_trip_by_id_v1_trips_trip__trip_id__get"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET /v1/trips/trip/{trip_id}"},"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":"Outgoing data"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Resources in visibility events can now report the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BARGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AIRPLANE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" types."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-customer-portal"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-visibility"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visibility"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-07-23"}],"sectionId":"/docs/section/changelog/2026-07-23"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-07-22"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-07-22"},"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":"API"},"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":"Removed:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Order status responses no longer include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first_pickup_stop"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The same information can be derived from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stops"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array, which is ordered by stop sequence: the first stop with a pickup "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"activity_label"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the first pickup stop, and likewise the last stop with a delivery "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"activity_label"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the last delivery stop."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v1/orders/order/{order_id}/status"},"children":[]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-07-22"}],"sectionId":"/docs/section/changelog/2026-07-22"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-07-20"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-07-20"},"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":"API"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Resource create, update and patch now accept "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_archived"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Sending "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_archived: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" reactivates a previously archived resource, restoring it with its existing data; sending "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" archives it. Omitting the field leaves the archive state unchanged."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-resource"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v1/resources/resource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT /v1/resources/resource/{resource_id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH /v1/resources/resource/{resource_id}"},"children":[]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-07-20"}],"sectionId":"/docs/section/changelog/2026-07-20"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-07-14"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-07-14"},"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":"API"},"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":"Fixed:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Payment status updates now accept "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNPAID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Reporting an invoice as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNPAID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" reopens its payment task and clears the paid amount and date on the invoice; previously the documented "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNPAID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value was rejected with a validation error."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-accounting"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accounting"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v1/accounting/sales-invoice/{id}/payment/update-status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v1/accounting/purchase-invoice/{id}/payment/update-status"},"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":"Webhooks"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Intermodal booking status updates can report estimated and actual stop times via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop_timestamps"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eta_timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"actual_start_timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"actual_end_timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"departure"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"arrival"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" stops. The timestamps are only applied when the integration is configured to sync stop times."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-intermodal-partner"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Intermodal partner"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/webhooks-inbound/intermodal-booking-status-webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST /v1/webhook/intermodal-status"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-07-14"}],"sectionId":"/docs/section/changelog/2026-07-14"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-07-10"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-07-10"},"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":"API"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Order status responses now include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first_pickup_stop"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v1/orders/order/{order_id}/status"},"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":"Changed:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_delivery_stop"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" now uses the documented order-status stop shape."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v1/orders/order/{order_id}/status"},"children":[]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-07-10"}],"sectionId":"/docs/section/changelog/2026-07-10"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-07-09"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-07-09"},"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":"API"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v1/resources/resource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" now documents the supported query filters: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_id:in"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resource_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resource_type:in"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-resource"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v1/resources/resource"},"children":[]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-07-09"}],"sectionId":"/docs/section/changelog/2026-07-09"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-07-07"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-07-07"},"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":"API"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Sales invoice and sales credit note responses now include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"e_invoicing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" registration metadata."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-accounting"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accounting"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-task"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Task"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-07-07"}],"sectionId":"/docs/section/changelog/2026-07-07"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-07-06"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-07-06"},"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":"API"},"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":"Changed:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Validation error responses now return an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array instead of the flat "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"detail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"path"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields. Each item is a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ValidationErrorDetail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"path"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"detail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; the array is always present and non-empty, so a single failure is a one-item array and integrators can handle one and many failures the same way."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-accounting"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accounting"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-authentication"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-company"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-document"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-resource"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-task"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Task"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-trip"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trip"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-07-06"}],"sectionId":"/docs/section/changelog/2026-07-06"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-07-03"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-07-03"},"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":"API"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" New "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v1/resources/resource_groups"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint lists the tenant's resource groups ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), cursor-paginated. Archived groups are excluded."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-resource"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Resource responses now include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resource_groups"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the groups the resource currently belongs to (deduplicated and sorted by name). A resource can belong to more than one group."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-resource"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH /v1/resources/resource/{resource_id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" accepts a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resource_group"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" reference to allocate the resource to a group, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to remove it from its current group."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-resource"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH /v1/resources/resource/{resource_id}"},"children":[]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-07-03"}],"sectionId":"/docs/section/changelog/2026-07-03"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-07-02"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-07-02"},"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":"API"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Location objects now include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customs_metadata"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customs_office_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") alongside "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"terminal_metadata"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-trip"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trip"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-07-02"}],"sectionId":"/docs/section/changelog/2026-07-02"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-07-01"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-07-01"},"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":"API"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Added the Location master-data API to create, update and retrieve locations, including address and opening hours. New endpoints: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"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":"/v1/locations/location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"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":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v1/locations/location/{location_id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-location"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Location"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-07-01"}],"sectionId":"/docs/section/changelog/2026-07-01"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-06-15"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-06-15"},"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":"Outgoing data"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The location dispatch webhook now includes a per-consignment "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tracking_link"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-location-booking"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Location booking"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-06-15"}],"sectionId":"/docs/section/changelog/2026-06-15"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-06-03"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-06-03"},"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":"Outgoing data"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Operational order visibility now includes goods information."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-customer-portal"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-visibility"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visibility"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-06-03"}],"sectionId":"/docs/section/changelog/2026-06-03"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-05-28"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-05-28"},"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":"Outgoing data"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Outgoing data now includes ADR hazard labels and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"special_provisions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for dangerous goods."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-05-28"}],"sectionId":"/docs/section/changelog/2026-05-28"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-05-23"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-05-23"},"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":"API"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Booking"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" now exposes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"vessel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"voyage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IMO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the associated references for intermodal flows."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-intermodal-partner"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Intermodal"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-05-23"}],"sectionId":"/docs/section/changelog/2026-05-23"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-05-20"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-05-20"},"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":"API"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ContainerStandardSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" gains the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FEET_24"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FEET_26"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values."},"children":[]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-05-20"}],"sectionId":"/docs/section/changelog/2026-05-20"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-05-19"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-05-19"},"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":"API"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DocumentType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enum is synced with the TMS, adding 23 new document types."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Resource"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v1/resources/resource/{resource_id}/validity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT /v1/resources/resource/{resource_id}/validity/{id}"},"children":[]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-05-19"}],"sectionId":"/docs/section/changelog/2026-05-19"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-05-18"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-05-18"},"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":"API"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TaskType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enum gains "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DISPATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", returned by the available-tasks and task endpoints."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-accounting"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accounting"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-task"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Task"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-05-18"}],"sectionId":"/docs/section/changelog/2026-05-18"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-05-12"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-05-12"},"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":"Outgoing data"},"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":"Changed:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"compatible_extras"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has been renamed to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"extras"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for consistency across resource models."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-resource"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-trip"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trip"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-05-12"}],"sectionId":"/docs/section/changelog/2026-05-12"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-05-07"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-05-07"},"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":"API"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Booking"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" now exposes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"seal_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-intermodal-partner"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Intermodal"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-05-07"}],"sectionId":"/docs/section/changelog/2026-05-07"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-05-05"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-05-05"},"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":"API"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreditNoteStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" gains the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRE_INVOICED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-accounting"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accounting"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-visibility"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visibility"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-05-05"}],"sectionId":"/docs/section/changelog/2026-05-05"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-04-27"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-04-27"},"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":"API"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Order models now expose "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_consignment_info_validated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", indicating whether consignment information has been validated."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Goods and handling units now return their "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order output, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ContainerType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" exposes the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"container_iso_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ShippingRoute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" now exposes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"modality"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-intermodal-partner"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Intermodal"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-04-27"}],"sectionId":"/docs/section/changelog/2026-04-27"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-04-24"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-04-24"},"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":"API"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ResourceTypeEnum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" gains "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CHASSIS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TimeWindow"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" exposes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"use_location_opening_hours"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-trip"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trip"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-04-24"}],"sectionId":"/docs/section/changelog/2026-04-24"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-04-21"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-04-21"},"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":"API"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Resource and equipment models ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Container"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Trailer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Vehicle"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and their resource variants) now expose their "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and driver resources expose "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_stop_location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-resource"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-04-21"}],"sectionId":"/docs/section/changelog/2026-04-21"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-04-17"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-04-17"},"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":"API"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PartialOrderUpdate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" now accepts an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"update"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object carrying order entity changes."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/webhooks-inbound/partial-order-update"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST /v1/webhook/partial-order-update"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-04-17"}],"sectionId":"/docs/section/changelog/2026-04-17"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-04-14"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-04-14"},"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":"Webhooks"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Added the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v1/webhook/e-invoicing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" inbound webhook."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-e-invoicing"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-invoicing"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-04-14"}],"sectionId":"/docs/section/changelog/2026-04-14"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-04-13"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-04-13"},"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":"API"},"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":"Changed:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BookingDimensions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" now exposes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cargo_weight"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tare_weight"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"verified_gross_mass"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; the single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"weight"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is deprecated."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-intermodal-partner"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Intermodal"},"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":"Deprecated:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Companies now use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"credit_policy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"credit_limit_total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is deprecated."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-accounting"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accounting"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-company"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-04-13"}],"sectionId":"/docs/section/changelog/2026-04-13"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-04-08"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-04-08"},"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":"API"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Added a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/me"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint returning the authenticated API user."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/system"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"System"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-04-08"}],"sectionId":"/docs/section/changelog/2026-04-08"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-04-07"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-04-07"},"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":"API"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Added the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v1/accounting/exchange-rate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-accounting"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accounting"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Consignments now expose "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"import_export"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ContactType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" gains "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SALES"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CUSTOMS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUALITY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CLAIMS_INSURANCE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CUSTOMER_CONTACT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-accounting"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accounting"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-company"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-trip"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trip"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Customs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" exposes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"has_customs_territory_crossing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PackagedItem"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" exposes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total_net_weight_kg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PackagingType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" exposes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"export_alias"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order"},"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":"Webhooks"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Added the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v1/webhook/tracking-update"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" inbound webhook."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-tracking"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tracking"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-04-07"}],"sectionId":"/docs/section/changelog/2026-04-07"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-03-23"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-03-23"},"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":"Outgoing data"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Fleet and subcontractor dispatch payloads now include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-fleet-dispatch"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fleet dispatch"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-subcontractor-dispatch"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subcontractor dispatch"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-03-23"}],"sectionId":"/docs/section/changelog/2026-03-23"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-03-17"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-03-17"},"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":"API"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Location output now includes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"latitude"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"longitude"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-accounting"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accounting"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-company"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-task"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Task"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-trip"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trip"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-03-17"}],"sectionId":"/docs/section/changelog/2026-03-17"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-03-13"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-03-13"},"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":"API"},"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":"Changed:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Company create and update inputs now accept "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"archived_customer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"archived_subcontractor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and these read-only fields are no longer returned on company output: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sales"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"credit_limit_total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timestamp_updated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-accounting"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accounting"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-company"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-trip"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trip"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-03-13"}],"sectionId":"/docs/section/changelog/2026-03-13"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-03-11"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-03-11"},"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":"API"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PackagedItem"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" now exposes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"import_export"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-order/order_export_v1_orders_order__order_id__export_get"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET /v1/orders/order/{order_id}/export"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-order/import_order_v1_orders_order_upload_post"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST /v1/orders/order/upload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/webhooks-inbound/order-import-webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST /v1/webhook"},"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":"Webhooks"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Added the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v1/webhook/document-import"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" inbound webhook."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-document-import"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document import"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Fleet status-update webhooks accept stop-group ETA windows via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eta_start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eta_end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Fleet dispatch"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/webhooks-inbound/fleet-status-update-webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST /v1/webhook/fleet-status-update"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-03-11"}],"sectionId":"/docs/section/changelog/2026-03-11"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-03-10"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-03-10"},"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":"Outgoing data"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Operational order visibility now includes stop ETA times ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eta_start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eta_end_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-customer-portal"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-visibility"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visibility"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-03-10"}],"sectionId":"/docs/section/changelog/2026-03-10"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-02-27"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-02-27"},"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":"API"},"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":"Changed:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Partial order updates now accept "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consignment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; the top-level "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is deprecated."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/webhooks-inbound/partial-order-update"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST /v1/webhook/partial-order-update"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-02-27"}],"sectionId":"/docs/section/changelog/2026-02-27"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-02-24"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-02-24"},"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":"API"},"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":"Deprecated:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Deprecated "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"container_load_unload_stop"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on order models."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PackagedItem"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" now exposes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"barcodes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"packaging_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and unit dimensions ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unit_height_m"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unit_length_m"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unit_width_m"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-order/order_export_v1_orders_order__order_id__export_get"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET /v1/orders/order/{order_id}/export"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-order/import_order_v1_orders_order_upload_post"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST /v1/orders/order/upload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/webhooks-inbound/order-import-webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST /v1/webhook"},"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":"Webhooks"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Fleet status-update webhooks accept stop ETA windows via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eta_start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eta_end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Fleet dispatch, Subcontractor dispatch"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/webhooks-inbound/fleet-status-update-webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST /v1/webhook/fleet-status-update"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/webhooks-inbound/subcontractor-status-update-webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST /v1/webhook/subco-status-update"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-02-24"}],"sectionId":"/docs/section/changelog/2026-02-24"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-02-16"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-02-16"},"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":"API"},"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":"Changed:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Purchase e-invoice and e-credit-note inputs now accept "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_credit_note"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields are removed."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" E-invoicing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/webhooks-inbound/e-invoicing-webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST /v1/webhook/e-invoicing"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-02-16"}],"sectionId":"/docs/section/changelog/2026-02-16"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-02-10"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-02-10"},"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":"API"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Location output now includes the location "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-accounting"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accounting"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-company"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-task"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Task"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-trip"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trip"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-02-10"}],"sectionId":"/docs/section/changelog/2026-02-10"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-01-23"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-01-23"},"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":"API"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Companies can be flagged as buyer/seller via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_buyer_or_seller"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and consignments now accept and return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"seller"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-accounting"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accounting"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-company"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Purchase e-invoices and e-credit-notes now include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoice_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" E-invoicing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/webhooks-inbound/e-invoicing-webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST /v1/webhook/e-invoicing"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-01-23"}],"sectionId":"/docs/section/changelog/2026-01-23"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-01-16"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-01-16"},"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":"API"},"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":"Changed:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Fleet resource models now expose "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billing_entity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; on partial resource inputs the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is replaced by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subcontractor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billing_entity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Resource"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH /v1/resources/resource/{resource_id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v1/resources/resource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT /v1/resources/resource/{resource_id}"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Companies now expose their "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billing_entities"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BillingEntity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" exposes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_default"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ContactType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" gains "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAYMENT_REMINDERS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-accounting"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accounting"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-company"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-resource"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-task"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Task"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-trip"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trip"},"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":"Removed:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Removed the unused "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"good_all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field from partial order updates."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/webhooks-inbound/partial-order-update"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST /v1/webhook/partial-order-update"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-01-16"}],"sectionId":"/docs/section/changelog/2026-01-16"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-01-09"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-01-09"},"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":"API"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PaymentTermCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" gains additional terms: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NET_12"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NET_20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NET_52"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NET_75"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"END_OF_MONTH_0_NET_{1,7,14,21,25}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" variants."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-accounting"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accounting"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-company"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-task"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Task"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-trip"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trip"},"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":"Outgoing data"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Operational order visibility now includes the customer "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-customer-portal"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-visibility"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visibility"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-01-09"}],"sectionId":"/docs/section/changelog/2026-01-09"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/changelog/2026-01-05"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2026-01-05"},"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":"API"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Added the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v1/accounting/sales-invoice/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v1/accounting/sales-credit-note/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoints for creating sales invoices and credit notes."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-accounting"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accounting"},"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":"Added:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LineItem"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" now exposes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dimension_4"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dimension_5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dimension_6"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-accounting"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accounting"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-task"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Task"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/docs/section/changelog/2026-01-05"}],"sectionId":"/docs/section/changelog/2026-01-05"}]}]}},{"type":"group","label":"Overview","link":"/docs/section/overview","routeSlug":"/docs/section/overview","items":[{"type":"link","label":"Documentation for Other Parties","link":"/docs/section/overview/documentation-for-other-parties","routeSlug":"/docs/section/overview/documentation-for-other-parties","content":null}],"content":null},{"type":"group","label":"Authentication","link":"/docs/section/authentication","routeSlug":"/docs/section/authentication","items":[{"type":"link","label":"Creating application credentials","link":"/docs/section/authentication/creating-application-credentials","routeSlug":"/docs/section/authentication/creating-application-credentials","content":null},{"type":"link","label":"Obtaining an access token","link":"/docs/section/authentication/obtaining-an-access-token","routeSlug":"/docs/section/authentication/obtaining-an-access-token","content":null},{"type":"link","label":"Understanding Basic Authentication","link":"/docs/section/authentication/understanding-basic-authentication","routeSlug":"/docs/section/authentication/understanding-basic-authentication","content":null},{"type":"link","label":"The API Call to Request Tokens","link":"/docs/section/authentication/the-api-call-to-request-tokens","routeSlug":"/docs/section/authentication/the-api-call-to-request-tokens","content":null},{"type":"link","label":"Request Details","link":"/docs/section/authentication/request-details","routeSlug":"/docs/section/authentication/request-details","content":null},{"type":"link","label":"Webhook authentication","link":"/docs/section/authentication/webhook-authentication","routeSlug":"/docs/section/authentication/webhook-authentication","content":null},{"type":"link","label":"API vs Webhook authentication summary","link":"/docs/section/authentication/api-vs-webhook-authentication-summary","routeSlug":"/docs/section/authentication/api-vs-webhook-authentication-summary","content":null},{"type":"link","label":"Common mistake","link":"/docs/section/authentication/common-mistake","routeSlug":"/docs/section/authentication/common-mistake","content":null},{"type":"link","label":"Example webhook request","link":"/docs/section/authentication/example-webhook-request","routeSlug":"/docs/section/authentication/example-webhook-request","content":null}],"content":null},{"type":"group","label":"Rate Limits","link":"/docs/section/rate-limits","routeSlug":"/docs/section/rate-limits","items":[{"type":"link","label":"Limits","link":"/docs/section/rate-limits/limits","routeSlug":"/docs/section/rate-limits/limits","content":null},{"type":"link","label":"Enforcement","link":"/docs/section/rate-limits/enforcement","routeSlug":"/docs/section/rate-limits/enforcement","content":null}],"content":null},{"type":"group","label":"API Best Practices","link":"/docs/section/api-best-practices","routeSlug":"/docs/section/api-best-practices","items":[{"type":"link","label":"Pagination","link":"/docs/section/api-best-practices/pagination","routeSlug":"/docs/section/api-best-practices/pagination","content":null},{"type":"link","label":"How pagination works","link":"/docs/section/api-best-practices/how-pagination-works","routeSlug":"/docs/section/api-best-practices/how-pagination-works","content":null},{"type":"link","label":"Example usage","link":"/docs/section/api-best-practices/example-usage","routeSlug":"/docs/section/api-best-practices/example-usage","content":null},{"type":"link","label":"Recommendations","link":"/docs/section/api-best-practices/recommendations","routeSlug":"/docs/section/api-best-practices/recommendations","content":null},{"type":"link","label":"Backward compatibility","link":"/docs/section/api-best-practices/backward-compatibility","routeSlug":"/docs/section/api-best-practices/backward-compatibility","content":null},{"type":"link","label":"Date and time formats","link":"/docs/section/api-best-practices/date-and-time-formats","routeSlug":"/docs/section/api-best-practices/date-and-time-formats","content":null}],"content":null},{"type":"group","label":"Concepts","link":"/docs/section/concepts","routeSlug":"/docs/section/concepts","items":[{"type":"link","label":"Company","link":"/docs/section/concepts/company","routeSlug":"/docs/section/concepts/company","content":null},{"type":"link","label":"Order","link":"/docs/section/concepts/order","routeSlug":"/docs/section/concepts/order","content":null},{"type":"link","label":"Stop","link":"/docs/section/concepts/stop","routeSlug":"/docs/section/concepts/stop","content":null},{"type":"link","label":"Stop group","link":"/docs/section/concepts/stop-group","routeSlug":"/docs/section/concepts/stop-group","content":null},{"type":"link","label":"Trip","link":"/docs/section/concepts/trip","routeSlug":"/docs/section/concepts/trip","content":null},{"type":"link","label":"Task","link":"/docs/section/concepts/task","routeSlug":"/docs/section/concepts/task","content":null},{"type":"link","label":"Resource","link":"/docs/section/concepts/resource","routeSlug":"/docs/section/concepts/resource","content":null},{"type":"link","label":"Unavailability","link":"/docs/section/concepts/unavailability","routeSlug":"/docs/section/concepts/unavailability","content":null},{"type":"link","label":"Status update","link":"/docs/section/concepts/status-update","routeSlug":"/docs/section/concepts/status-update","content":null},{"type":"link","label":"Document","link":"/docs/section/concepts/document","routeSlug":"/docs/section/concepts/document","content":null}],"content":null},{"type":"group","label":"Postman collection","link":"/docs/section/postman-collection","routeSlug":"/docs/section/postman-collection","items":[{"type":"link","label":"Instructions","link":"/docs/section/postman-collection/instructions","routeSlug":"/docs/section/postman-collection/instructions","content":null}],"content":null},{"type":"group","label":"Functionality","link":"/docs/section/functionality","routeSlug":"/docs/section/functionality","items":[{"type":"link","label":"Order management","link":"/docs/section/functionality/order-management","routeSlug":"/docs/section/functionality/order-management","content":null},{"type":"link","label":"Trip information","link":"/docs/section/functionality/trip-information","routeSlug":"/docs/section/functionality/trip-information","content":null},{"type":"link","label":"Resource management","link":"/docs/section/functionality/resource-management","routeSlug":"/docs/section/functionality/resource-management","content":null},{"type":"link","label":"Resource","link":"/docs/section/functionality/resource","routeSlug":"/docs/section/functionality/resource","content":null},{"type":"link","label":"Unavailability","link":"/docs/section/functionality/unavailability","routeSlug":"/docs/section/functionality/unavailability","content":null},{"type":"link","label":"Visibility","link":"/docs/section/functionality/visibility","routeSlug":"/docs/section/functionality/visibility","content":null},{"type":"link","label":"Order dispatch","link":"/docs/section/functionality/order-dispatch","routeSlug":"/docs/section/functionality/order-dispatch","content":null},{"type":"link","label":"Documents","link":"/docs/section/functionality/documents","routeSlug":"/docs/section/functionality/documents","content":null},{"type":"link","label":"Request additional endpoints","link":"/docs/section/functionality/request-additional-endpoints","routeSlug":"/docs/section/functionality/request-additional-endpoints","content":null}],"content":null},{"type":"group","label":"Transport order creation & status","link":"/docs/section/transport-order-creation-and-status","routeSlug":"/docs/section/transport-order-creation-and-status","items":[{"type":"link","label":"Order creation metadata","link":"/docs/section/transport-order-creation-and-status/order-creation-metadata","routeSlug":"/docs/section/transport-order-creation-and-status/order-creation-metadata","content":null},{"type":"link","label":"Order identifier","link":"/docs/section/transport-order-creation-and-status/order-identifier","routeSlug":"/docs/section/transport-order-creation-and-status/order-identifier","content":null},{"type":"link","label":"Create an order","link":"/docs/section/transport-order-creation-and-status/create-an-order","routeSlug":"/docs/section/transport-order-creation-and-status/create-an-order","content":null},{"type":"link","label":"Update an order","link":"/docs/section/transport-order-creation-and-status/update-an-order","routeSlug":"/docs/section/transport-order-creation-and-status/update-an-order","content":null},{"type":"link","label":"Cancel an order","link":"/docs/section/transport-order-creation-and-status/cancel-an-order","routeSlug":"/docs/section/transport-order-creation-and-status/cancel-an-order","content":null},{"type":"link","label":"Export an existing order","link":"/docs/section/transport-order-creation-and-status/export-an-existing-order","routeSlug":"/docs/section/transport-order-creation-and-status/export-an-existing-order","content":null},{"type":"link","label":"Fetch order data and status","link":"/docs/section/transport-order-creation-and-status/fetch-order-data-and-status","routeSlug":"/docs/section/transport-order-creation-and-status/fetch-order-data-and-status","content":null},{"type":"link","label":"Container orders","link":"/docs/section/transport-order-creation-and-status/container-orders","routeSlug":"/docs/section/transport-order-creation-and-status/container-orders","content":null},{"type":"link","label":"Import","link":"/docs/section/transport-order-creation-and-status/import","routeSlug":"/docs/section/transport-order-creation-and-status/import","content":null},{"type":"link","label":"Export","link":"/docs/section/transport-order-creation-and-status/export","routeSlug":"/docs/section/transport-order-creation-and-status/export","content":null},{"type":"link","label":"Create a loaded container import transport order","link":"/docs/section/transport-order-creation-and-status/create-a-loaded-container-import-transport-order","routeSlug":"/docs/section/transport-order-creation-and-status/create-a-loaded-container-import-transport-order","content":null},{"type":"link","label":"Create a loaded container export transport order","link":"/docs/section/transport-order-creation-and-status/create-a-loaded-container-export-transport-order","routeSlug":"/docs/section/transport-order-creation-and-status/create-a-loaded-container-export-transport-order","content":null},{"type":"link","label":"Adding custom stops","link":"/docs/section/transport-order-creation-and-status/adding-custom-stops","routeSlug":"/docs/section/transport-order-creation-and-status/adding-custom-stops","content":null},{"type":"link","label":"Examples","link":"/docs/section/transport-order-creation-and-status/examples","routeSlug":"/docs/section/transport-order-creation-and-status/examples","content":null},{"type":"link","label":"Basic order","link":"/docs/section/transport-order-creation-and-status/basic-order","routeSlug":"/docs/section/transport-order-creation-and-status/basic-order","content":null},{"type":"link","label":"Container IMPORT scenario","link":"/docs/section/transport-order-creation-and-status/container-import-scenario","routeSlug":"/docs/section/transport-order-creation-and-status/container-import-scenario","content":null},{"type":"link","label":"Container EXPORT scenario","link":"/docs/section/transport-order-creation-and-status/container-export-scenario","routeSlug":"/docs/section/transport-order-creation-and-status/container-export-scenario","content":null},{"type":"link","label":"Order with multiple stops example","link":"/docs/section/transport-order-creation-and-status/order-with-multiple-stops-example","routeSlug":"/docs/section/transport-order-creation-and-status/order-with-multiple-stops-example","content":null},{"type":"link","label":"Order with ADR goods","link":"/docs/section/transport-order-creation-and-status/order-with-adr-goods","routeSlug":"/docs/section/transport-order-creation-and-status/order-with-adr-goods","content":null},{"type":"link","label":"Order with pallets and custom barcodes","link":"/docs/section/transport-order-creation-and-status/order-with-pallets-and-custom-barcodes","routeSlug":"/docs/section/transport-order-creation-and-status/order-with-pallets-and-custom-barcodes","content":null}],"content":null},{"type":"group","label":"Status updates","link":"/docs/section/status-updates","routeSlug":"/docs/section/status-updates","items":[{"type":"link","label":"Task","link":"/docs/section/status-updates/task","routeSlug":"/docs/section/status-updates/task","content":null},{"type":"link","label":"Order","link":"/docs/section/status-updates/order","routeSlug":"/docs/section/status-updates/order","content":null},{"type":"link","label":"Stop","link":"/docs/section/status-updates/stop","routeSlug":"/docs/section/status-updates/stop","content":null},{"type":"link","label":"Booking","link":"/docs/section/status-updates/booking","routeSlug":"/docs/section/status-updates/booking","content":null}],"content":null},{"type":"link","label":"Visibility","link":"/docs/section/visibility","routeSlug":"/docs/section/visibility","content":null},{"type":"group","label":"Accounting","link":"/docs/section/accounting","routeSlug":"/docs/section/accounting","items":[{"type":"link","label":"Synchronize invoices/credit notes","link":"/docs/section/accounting/synchronize-invoicescredit-notes","routeSlug":"/docs/section/accounting/synchronize-invoicescredit-notes","content":null},{"type":"link","label":"Example","link":"/docs/section/accounting/example","routeSlug":"/docs/section/accounting/example","content":null},{"type":"link","label":"Fetch updated customer information","link":"/docs/section/accounting/fetch-updated-customer-information","routeSlug":"/docs/section/accounting/fetch-updated-customer-information","content":null},{"type":"link","label":"Example","link":"/docs/section/accounting/example","routeSlug":"/docs/section/accounting/example","content":null},{"type":"link","label":"Synchronize blocked status of customer","link":"/docs/section/accounting/synchronize-blocked-status-of-customer","routeSlug":"/docs/section/accounting/synchronize-blocked-status-of-customer","content":null},{"type":"link","label":"Example","link":"/docs/section/accounting/example","routeSlug":"/docs/section/accounting/example","content":null},{"type":"link","label":"Creating contacts for a customer or subcontractor","link":"/docs/section/accounting/creating-contacts-for-a-customer-or-subcontractor","routeSlug":"/docs/section/accounting/creating-contacts-for-a-customer-or-subcontractor","content":null},{"type":"link","label":"Example","link":"/docs/section/accounting/example","routeSlug":"/docs/section/accounting/example","content":null},{"type":"link","label":"Updating contacts for a customer or subcontractor","link":"/docs/section/accounting/updating-contacts-for-a-customer-or-subcontractor","routeSlug":"/docs/section/accounting/updating-contacts-for-a-customer-or-subcontractor","content":null},{"type":"link","label":"Example","link":"/docs/section/accounting/example","routeSlug":"/docs/section/accounting/example","content":null},{"type":"link","label":"Archiving a contact for a customer or subcontractor","link":"/docs/section/accounting/archiving-a-contact-for-a-customer-or-subcontractor","routeSlug":"/docs/section/accounting/archiving-a-contact-for-a-customer-or-subcontractor","content":null},{"type":"link","label":"Example","link":"/docs/section/accounting/example","routeSlug":"/docs/section/accounting/example","content":null}],"content":null},{"type":"group","label":"Resources","link":"/docs/section/resources","routeSlug":"/docs/section/resources","items":[{"type":"link","label":"Resource groups","link":"/docs/section/resources/resource-groups","routeSlug":"/docs/section/resources/resource-groups","content":null},{"type":"link","label":"Looking up resource groups","link":"/docs/section/resources/looking-up-resource-groups","routeSlug":"/docs/section/resources/looking-up-resource-groups","content":null},{"type":"link","label":"Reading a resource's groups","link":"/docs/section/resources/reading-a-resource's-groups","routeSlug":"/docs/section/resources/reading-a-resource's-groups","content":null},{"type":"link","label":"Updating a resource's group","link":"/docs/section/resources/updating-a-resource's-group","routeSlug":"/docs/section/resources/updating-a-resource's-group","content":null},{"type":"link","label":"Errors","link":"/docs/section/resources/errors","routeSlug":"/docs/section/resources/errors","content":null},{"type":"link","label":"Extras","link":"/docs/section/resources/extras","routeSlug":"/docs/section/resources/extras","content":null},{"type":"link","label":"Setting extras on create","link":"/docs/section/resources/setting-extras-on-create","routeSlug":"/docs/section/resources/setting-extras-on-create","content":null},{"type":"link","label":"Response (all read endpoints)","link":"/docs/section/resources/response-(all-read-endpoints)","routeSlug":"/docs/section/resources/response-(all-read-endpoints)","content":null},{"type":"link","label":"Updating extras","link":"/docs/section/resources/updating-extras","routeSlug":"/docs/section/resources/updating-extras","content":null},{"type":"link","label":"Error — duplicate code","link":"/docs/section/resources/error-duplicate-code","routeSlug":"/docs/section/resources/error-duplicate-code","content":null},{"type":"link","label":"Unavailabilities","link":"/docs/section/resources/unavailabilities","routeSlug":"/docs/section/resources/unavailabilities","content":null},{"type":"link","label":"Creating a unavailability","link":"/docs/section/resources/creating-a-unavailability","routeSlug":"/docs/section/resources/creating-a-unavailability","content":null},{"type":"link","label":"Updating an unavailability","link":"/docs/section/resources/updating-an-unavailability","routeSlug":"/docs/section/resources/updating-an-unavailability","content":null},{"type":"link","label":"Deleting an unavailability","link":"/docs/section/resources/deleting-an-unavailability","routeSlug":"/docs/section/resources/deleting-an-unavailability","content":null}],"content":null},{"type":"group","label":"E-invoicing","link":"/docs/section/e-invoicing","routeSlug":"/docs/section/e-invoicing","items":[{"type":"link","label":"Peppol","link":"/docs/section/e-invoicing/peppol","routeSlug":"/docs/section/e-invoicing/peppol","content":null},{"type":"link","label":"Workflows","link":"/docs/section/e-invoicing/workflows","routeSlug":"/docs/section/e-invoicing/workflows","content":null},{"type":"link","label":"Importing E-invoices into Qargo via webhook","link":"/docs/section/e-invoicing/importing-e-invoices-into-qargo-via-webhook","routeSlug":"/docs/section/e-invoicing/importing-e-invoices-into-qargo-via-webhook","content":null}],"content":null},{"type":"group","label":"Question paths and answers","link":"/docs/section/question-paths-and-answers","routeSlug":"/docs/section/question-paths-and-answers","items":[{"type":"link","label":"Document sync via question_paths","link":"/docs/section/question-paths-and-answers/document-sync-via-question_paths","routeSlug":"/docs/section/question-paths-and-answers/document-sync-via-question_paths","content":null},{"type":"link","label":"Replacing a document","link":"/docs/section/question-paths-and-answers/replacing-a-document","routeSlug":"/docs/section/question-paths-and-answers/replacing-a-document","content":null},{"type":"link","label":"remote_document","link":"/docs/section/question-paths-and-answers/remote_document","routeSlug":"/docs/section/question-paths-and-answers/remote_document","content":null},{"type":"link","label":"embedded_document","link":"/docs/section/question-paths-and-answers/embedded_document","routeSlug":"/docs/section/question-paths-and-answers/embedded_document","content":null},{"type":"link","label":"Actions","link":"/docs/section/question-paths-and-answers/actions","routeSlug":"/docs/section/question-paths-and-answers/actions","content":null},{"type":"link","label":"assign_resource","link":"/docs/section/question-paths-and-answers/assign_resource","routeSlug":"/docs/section/question-paths-and-answers/assign_resource","content":null},{"type":"link","label":"scan_barcode","link":"/docs/section/question-paths-and-answers/scan_barcode","routeSlug":"/docs/section/question-paths-and-answers/scan_barcode","content":null},{"type":"link","label":"stop_match","link":"/docs/section/question-paths-and-answers/stop_match","routeSlug":"/docs/section/question-paths-and-answers/stop_match","content":null},{"type":"link","label":"stop_match.leg","link":"/docs/section/question-paths-and-answers/stop_match.leg","routeSlug":"/docs/section/question-paths-and-answers/stop_match.leg","content":null},{"type":"link","label":"stop_match.location","link":"/docs/section/question-paths-and-answers/stop_match.location","routeSlug":"/docs/section/question-paths-and-answers/stop_match.location","content":null}],"content":null},{"type":"group","label":"MCP","link":"/docs/section/mcp","routeSlug":"/docs/section/mcp","items":[{"type":"link","label":"What it is","link":"/docs/section/mcp/what-it-is","routeSlug":"/docs/section/mcp/what-it-is","content":null},{"type":"link","label":"Endpoint","link":"/docs/section/mcp/endpoint","routeSlug":"/docs/section/mcp/endpoint","content":null},{"type":"link","label":"Not the same as the documentation MCP","link":"/docs/section/mcp/not-the-same-as-the-documentation-mcp","routeSlug":"/docs/section/mcp/not-the-same-as-the-documentation-mcp","content":null},{"type":"link","label":"Prerequisites","link":"/docs/section/mcp/prerequisites","routeSlug":"/docs/section/mcp/prerequisites","content":null},{"type":"link","label":"Connecting","link":"/docs/section/mcp/connecting","routeSlug":"/docs/section/mcp/connecting","content":null},{"type":"link","label":"Flow","link":"/docs/section/mcp/flow","routeSlug":"/docs/section/mcp/flow","content":null},{"type":"link","label":"Authorisation server details","link":"/docs/section/mcp/authorisation-server-details","routeSlug":"/docs/section/mcp/authorisation-server-details","content":null},{"type":"link","label":"Token model","link":"/docs/section/mcp/token-model","routeSlug":"/docs/section/mcp/token-model","content":null},{"type":"link","label":"Sessions","link":"/docs/section/mcp/sessions","routeSlug":"/docs/section/mcp/sessions","content":null},{"type":"link","label":"Client setup","link":"/docs/section/mcp/client-setup","routeSlug":"/docs/section/mcp/client-setup","content":null},{"type":"link","label":"Claude Desktop and claude.ai","link":"/docs/section/mcp/claude-desktop-and-claude.ai","routeSlug":"/docs/section/mcp/claude-desktop-and-claude.ai","content":null},{"type":"link","label":"Claude Code","link":"/docs/section/mcp/claude-code","routeSlug":"/docs/section/mcp/claude-code","content":null},{"type":"link","label":"ChatGPT","link":"/docs/section/mcp/chatgpt","routeSlug":"/docs/section/mcp/chatgpt","content":null},{"type":"link","label":"Gemini","link":"/docs/section/mcp/gemini","routeSlug":"/docs/section/mcp/gemini","content":null},{"type":"link","label":"Other clients","link":"/docs/section/mcp/other-clients","routeSlug":"/docs/section/mcp/other-clients","content":null},{"type":"link","label":"Tools and access levels","link":"/docs/section/mcp/tools-and-access-levels","routeSlug":"/docs/section/mcp/tools-and-access-levels","content":null},{"type":"link","label":"Tools","link":"/docs/section/mcp/tools","routeSlug":"/docs/section/mcp/tools","content":null},{"type":"link","label":"Tool annotations","link":"/docs/section/mcp/tool-annotations","routeSlug":"/docs/section/mcp/tool-annotations","content":null},{"type":"link","label":"Operation allowlist","link":"/docs/section/mcp/operation-allowlist","routeSlug":"/docs/section/mcp/operation-allowlist","content":null},{"type":"link","label":"Access levels","link":"/docs/section/mcp/access-levels","routeSlug":"/docs/section/mcp/access-levels","content":null},{"type":"link","label":"Errors","link":"/docs/section/mcp/errors","routeSlug":"/docs/section/mcp/errors","content":null},{"type":"link","label":"Limits and safeguards","link":"/docs/section/mcp/limits-and-safeguards","routeSlug":"/docs/section/mcp/limits-and-safeguards","content":null},{"type":"link","label":"Production write protection","link":"/docs/section/mcp/production-write-protection","routeSlug":"/docs/section/mcp/production-write-protection","content":null},{"type":"link","label":"Rate limits","link":"/docs/section/mcp/rate-limits","routeSlug":"/docs/section/mcp/rate-limits","content":null},{"type":"link","label":"Response size and pagination","link":"/docs/section/mcp/response-size-and-pagination","routeSlug":"/docs/section/mcp/response-size-and-pagination","content":null},{"type":"link","label":"What is out of scope","link":"/docs/section/mcp/what-is-out-of-scope","routeSlug":"/docs/section/mcp/what-is-out-of-scope","content":null},{"type":"link","label":"Operational guidance","link":"/docs/section/mcp/operational-guidance","routeSlug":"/docs/section/mcp/operational-guidance","content":null}],"content":null},{"type":"group","label":"Changelog","link":"/docs/section/changelog","routeSlug":"/docs/section/changelog","items":[{"type":"link","label":"2026-09-04","link":"/docs/section/changelog/2026-09-04","routeSlug":"/docs/section/changelog/2026-09-04","content":null},{"type":"link","label":"2026-09-01","link":"/docs/section/changelog/2026-09-01","routeSlug":"/docs/section/changelog/2026-09-01","content":null},{"type":"link","label":"2026-08-28","link":"/docs/section/changelog/2026-08-28","routeSlug":"/docs/section/changelog/2026-08-28","content":null},{"type":"link","label":"2026-08-26","link":"/docs/section/changelog/2026-08-26","routeSlug":"/docs/section/changelog/2026-08-26","content":null},{"type":"link","label":"2026-08-24","link":"/docs/section/changelog/2026-08-24","routeSlug":"/docs/section/changelog/2026-08-24","content":null},{"type":"link","label":"2026-08-19","link":"/docs/section/changelog/2026-08-19","routeSlug":"/docs/section/changelog/2026-08-19","content":null},{"type":"link","label":"2026-08-14","link":"/docs/section/changelog/2026-08-14","routeSlug":"/docs/section/changelog/2026-08-14","content":null},{"type":"link","label":"2026-08-13","link":"/docs/section/changelog/2026-08-13","routeSlug":"/docs/section/changelog/2026-08-13","content":null},{"type":"link","label":"2026-08-12","link":"/docs/section/changelog/2026-08-12","routeSlug":"/docs/section/changelog/2026-08-12","content":null},{"type":"link","label":"2026-08-11","link":"/docs/section/changelog/2026-08-11","routeSlug":"/docs/section/changelog/2026-08-11","content":null},{"type":"link","label":"2026-08-10","link":"/docs/section/changelog/2026-08-10","routeSlug":"/docs/section/changelog/2026-08-10","content":null},{"type":"link","label":"2026-08-06","link":"/docs/section/changelog/2026-08-06","routeSlug":"/docs/section/changelog/2026-08-06","content":null},{"type":"link","label":"2026-08-05","link":"/docs/section/changelog/2026-08-05","routeSlug":"/docs/section/changelog/2026-08-05","content":null},{"type":"link","label":"2026-08-03","link":"/docs/section/changelog/2026-08-03","routeSlug":"/docs/section/changelog/2026-08-03","content":null},{"type":"link","label":"2026-07-31","link":"/docs/section/changelog/2026-07-31","routeSlug":"/docs/section/changelog/2026-07-31","content":null},{"type":"link","label":"2026-07-29","link":"/docs/section/changelog/2026-07-29","routeSlug":"/docs/section/changelog/2026-07-29","content":null},{"type":"link","label":"2026-07-24","link":"/docs/section/changelog/2026-07-24","routeSlug":"/docs/section/changelog/2026-07-24","content":null},{"type":"link","label":"2026-07-23","link":"/docs/section/changelog/2026-07-23","routeSlug":"/docs/section/changelog/2026-07-23","content":null},{"type":"link","label":"2026-07-22","link":"/docs/section/changelog/2026-07-22","routeSlug":"/docs/section/changelog/2026-07-22","content":null},{"type":"link","label":"2026-07-20","link":"/docs/section/changelog/2026-07-20","routeSlug":"/docs/section/changelog/2026-07-20","content":null},{"type":"link","label":"2026-07-14","link":"/docs/section/changelog/2026-07-14","routeSlug":"/docs/section/changelog/2026-07-14","content":null},{"type":"link","label":"2026-07-10","link":"/docs/section/changelog/2026-07-10","routeSlug":"/docs/section/changelog/2026-07-10","content":null},{"type":"link","label":"2026-07-09","link":"/docs/section/changelog/2026-07-09","routeSlug":"/docs/section/changelog/2026-07-09","content":null},{"type":"link","label":"2026-07-07","link":"/docs/section/changelog/2026-07-07","routeSlug":"/docs/section/changelog/2026-07-07","content":null},{"type":"link","label":"2026-07-06","link":"/docs/section/changelog/2026-07-06","routeSlug":"/docs/section/changelog/2026-07-06","content":null},{"type":"link","label":"2026-07-03","link":"/docs/section/changelog/2026-07-03","routeSlug":"/docs/section/changelog/2026-07-03","content":null},{"type":"link","label":"2026-07-02","link":"/docs/section/changelog/2026-07-02","routeSlug":"/docs/section/changelog/2026-07-02","content":null},{"type":"link","label":"2026-07-01","link":"/docs/section/changelog/2026-07-01","routeSlug":"/docs/section/changelog/2026-07-01","content":null},{"type":"link","label":"2026-06-15","link":"/docs/section/changelog/2026-06-15","routeSlug":"/docs/section/changelog/2026-06-15","content":null},{"type":"link","label":"2026-06-03","link":"/docs/section/changelog/2026-06-03","routeSlug":"/docs/section/changelog/2026-06-03","content":null},{"type":"link","label":"2026-05-28","link":"/docs/section/changelog/2026-05-28","routeSlug":"/docs/section/changelog/2026-05-28","content":null},{"type":"link","label":"2026-05-23","link":"/docs/section/changelog/2026-05-23","routeSlug":"/docs/section/changelog/2026-05-23","content":null},{"type":"link","label":"2026-05-20","link":"/docs/section/changelog/2026-05-20","routeSlug":"/docs/section/changelog/2026-05-20","content":null},{"type":"link","label":"2026-05-19","link":"/docs/section/changelog/2026-05-19","routeSlug":"/docs/section/changelog/2026-05-19","content":null},{"type":"link","label":"2026-05-18","link":"/docs/section/changelog/2026-05-18","routeSlug":"/docs/section/changelog/2026-05-18","content":null},{"type":"link","label":"2026-05-12","link":"/docs/section/changelog/2026-05-12","routeSlug":"/docs/section/changelog/2026-05-12","content":null},{"type":"link","label":"2026-05-07","link":"/docs/section/changelog/2026-05-07","routeSlug":"/docs/section/changelog/2026-05-07","content":null},{"type":"link","label":"2026-05-05","link":"/docs/section/changelog/2026-05-05","routeSlug":"/docs/section/changelog/2026-05-05","content":null},{"type":"link","label":"2026-04-27","link":"/docs/section/changelog/2026-04-27","routeSlug":"/docs/section/changelog/2026-04-27","content":null},{"type":"link","label":"2026-04-24","link":"/docs/section/changelog/2026-04-24","routeSlug":"/docs/section/changelog/2026-04-24","content":null},{"type":"link","label":"2026-04-21","link":"/docs/section/changelog/2026-04-21","routeSlug":"/docs/section/changelog/2026-04-21","content":null},{"type":"link","label":"2026-04-17","link":"/docs/section/changelog/2026-04-17","routeSlug":"/docs/section/changelog/2026-04-17","content":null},{"type":"link","label":"2026-04-14","link":"/docs/section/changelog/2026-04-14","routeSlug":"/docs/section/changelog/2026-04-14","content":null},{"type":"link","label":"2026-04-13","link":"/docs/section/changelog/2026-04-13","routeSlug":"/docs/section/changelog/2026-04-13","content":null},{"type":"link","label":"2026-04-08","link":"/docs/section/changelog/2026-04-08","routeSlug":"/docs/section/changelog/2026-04-08","content":null},{"type":"link","label":"2026-04-07","link":"/docs/section/changelog/2026-04-07","routeSlug":"/docs/section/changelog/2026-04-07","content":null},{"type":"link","label":"2026-03-23","link":"/docs/section/changelog/2026-03-23","routeSlug":"/docs/section/changelog/2026-03-23","content":null},{"type":"link","label":"2026-03-17","link":"/docs/section/changelog/2026-03-17","routeSlug":"/docs/section/changelog/2026-03-17","content":null},{"type":"link","label":"2026-03-13","link":"/docs/section/changelog/2026-03-13","routeSlug":"/docs/section/changelog/2026-03-13","content":null},{"type":"link","label":"2026-03-11","link":"/docs/section/changelog/2026-03-11","routeSlug":"/docs/section/changelog/2026-03-11","content":null},{"type":"link","label":"2026-03-10","link":"/docs/section/changelog/2026-03-10","routeSlug":"/docs/section/changelog/2026-03-10","content":null},{"type":"link","label":"2026-02-27","link":"/docs/section/changelog/2026-02-27","routeSlug":"/docs/section/changelog/2026-02-27","content":null},{"type":"link","label":"2026-02-24","link":"/docs/section/changelog/2026-02-24","routeSlug":"/docs/section/changelog/2026-02-24","content":null},{"type":"link","label":"2026-02-16","link":"/docs/section/changelog/2026-02-16","routeSlug":"/docs/section/changelog/2026-02-16","content":null},{"type":"link","label":"2026-02-10","link":"/docs/section/changelog/2026-02-10","routeSlug":"/docs/section/changelog/2026-02-10","content":null},{"type":"link","label":"2026-01-23","link":"/docs/section/changelog/2026-01-23","routeSlug":"/docs/section/changelog/2026-01-23","content":null},{"type":"link","label":"2026-01-16","link":"/docs/section/changelog/2026-01-16","routeSlug":"/docs/section/changelog/2026-01-16","content":null},{"type":"link","label":"2026-01-09","link":"/docs/section/changelog/2026-01-09","routeSlug":"/docs/section/changelog/2026-01-09","content":null},{"type":"link","label":"2026-01-05","link":"/docs/section/changelog/2026-01-05","routeSlug":"/docs/section/changelog/2026-01-05","content":null}],"content":null},{"type":"separator","label":"Use cases","content":null},{"type":"group","label":"Use case / Accounting","link":"/docs/use-case-accounting","routeSlug":"/docs/use-case-accounting","items":[{"label":"List Accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-accounting/list_accounts_v1_accounting_accounts_get","routeSlug":"/docs/use-case-accounting/list_accounts_v1_accounting_accounts_get","metadata":{"seo":{"title":"List Accounts","description":"Lists accounting codes (GL / nominal codes) for the tenant, with optional filtering and pagination."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"List_accounts_v1_accounting_accounts_get","name":"List Accounts","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1accounts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Accounts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists accounting codes (GL / nominal codes) for the tenant, with optional filtering and pagination."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_89","description":"Pagination cursor. Mutually exclusive with other query parameters"},{"name":"archived","in":"query","schemaId":"schema_90","description":"Filter by archived status. Omit to return all accounts."},{"name":"billing_entity_code","in":"query","schemaId":"schema_91","description":"Filter by billing entity code."},{"name":"code","in":"query","schemaId":"schema_92","description":"Accounting code to match exactly."},{"name":"code:in","in":"query","schemaId":"schema_93","description":"Accounting codes to match. Comma-separated list."}],"pointer":"/paths/~1v1~1accounting~1accounts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/accounts","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_89"},{"name":"archived","in":"query","required":false,"schemaId":"schema_90"},{"name":"billing_entity_code","in":"query","required":false,"schemaId":"schema_91"},{"name":"code","in":"query","required":false,"schemaId":"schema_92"},{"name":"code:in","in":"query","required":false,"schemaId":"schema_93"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/accounts","href":"use-case-accounting/list_accounts_v1_accounting_accounts_get","openApiOperationId":"List_accounts_v1_accounting_accounts_get","summary":"List Accounts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListAccountOutput"}},"schemaId":"components/schemas/ListAccountOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1accounts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListAccountOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListAccountOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-accounting/list_accounts_v1_accounting_accounts_get"}],"panels":[]}]},"httpPath":"/v1/accounting/accounts"},{"label":"Retrieve Account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-accounting/retrieve_account_v1_accounting_accounts__id__get","routeSlug":"/docs/use-case-accounting/retrieve_account_v1_accounting_accounts__id__get","metadata":{"seo":{"title":"Retrieve Account","description":"Retrieves a single accounting code (GL / nominal code) by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Retrieve_account_v1_accounting_accounts__id__get","name":"Retrieve Account","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1accounts~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a single accounting code (GL / nominal code) by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1accounts~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/accounts/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/accounts/{id}","href":"use-case-accounting/retrieve_account_v1_accounting_accounts__id__get","openApiOperationId":"Retrieve_account_v1_accounting_accounts__id__get","summary":"Retrieve Account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/api__accounting__models__master_data__AccountOutput"}},"schemaId":"components/schemas/api__accounting__models__master_data__AccountOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1accounts~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/api__accounting__models__master_data__AccountOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/api__accounting__models__master_data__AccountOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-accounting/retrieve_account_v1_accounting_accounts__id__get"}],"panels":[]}]},"httpPath":"/v1/accounting/accounts/{id}"},{"label":"Create An Exchange Rate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-accounting/create_an_exchange_rate_v1_accounting_exchange_rate_post","routeSlug":"/docs/use-case-accounting/create_an_exchange_rate_v1_accounting_exchange_rate_post","metadata":{"seo":{"title":"Create An Exchange Rate","description":"Creates an exchange rate in Qargo for the given currency pair and date."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create_an_exchange_rate_v1_accounting_exchange_rate_post","name":"Create An Exchange Rate","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1exchange-rate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create An Exchange Rate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates an exchange rate in Qargo for the given currency pair and date."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExchangeRateInput"}},"schemaId":"components/schemas/ExchangeRateInput","pointer":"/paths/~1v1~1accounting~1exchange-rate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/accounting/exchange-rate","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ExchangeRateInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/exchange-rate","href":"use-case-accounting/create_an_exchange_rate_v1_accounting_exchange_rate_post","openApiOperationId":"Create_an_exchange_rate_v1_accounting_exchange_rate_post","summary":"Create An Exchange Rate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/ExchangeRateInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExchangeRateInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExchangeRateOutput"}},"schemaId":"components/schemas/ExchangeRateOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1exchange-rate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExchangeRateOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExchangeRateOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-accounting/create_an_exchange_rate_v1_accounting_exchange_rate_post"}],"panels":[]}]},"httpPath":"/v1/accounting/exchange-rate"},{"label":"List Exchange Rates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-accounting/list_exchange_rates_v1_accounting_exchange_rate_get","routeSlug":"/docs/use-case-accounting/list_exchange_rates_v1_accounting_exchange_rate_get","metadata":{"seo":{"title":"List Exchange Rates","description":"Retrieves a list of exchange rates with optional currency and date filters. When filtering by both from_currency and to_currency, results are returned in the requested direction regardless of how they are stored internally."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"List_exchange_rates_v1_accounting_exchange_rate_get","name":"List Exchange Rates","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1exchange-rate/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Exchange Rates","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":"Retrieves a list of exchange rates with optional currency and date filters. When filtering by both from_currency and to_currency, results are returned in the requested direction regardless of how they are stored internally."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_89","description":"Pagination cursor. Mutually exclusive with other query parameters"},{"name":"from_currency","in":"query","schemaId":"schema_95","description":"Filter by source currency code (ISO 4217)."},{"name":"from_currency:in","in":"query","schemaId":"schema_96","description":"Source currency codes to match (ISO 4217). Comma-separated list. Matches either side of the currency pair."},{"name":"to_currency","in":"query","schemaId":"schema_97","description":"Filter by target currency code (ISO 4217)."},{"name":"to_currency:in","in":"query","schemaId":"schema_98","description":"Target currency codes to match (ISO 4217). Comma-separated list. Matches either side of the currency pair."},{"name":"exchange_rate_date:gte","in":"query","schemaId":"schema_99","description":"Filter exchange rates on or after this date."},{"name":"exchange_rate_date:lte","in":"query","schemaId":"schema_100","description":"Filter exchange rates on or before this date."}],"pointer":"/paths/~1v1~1accounting~1exchange-rate/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/exchange-rate","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_89"},{"name":"from_currency","in":"query","required":false,"schemaId":"schema_95"},{"name":"from_currency:in","in":"query","required":false,"schemaId":"schema_96"},{"name":"to_currency","in":"query","required":false,"schemaId":"schema_97"},{"name":"to_currency:in","in":"query","required":false,"schemaId":"schema_98"},{"name":"exchange_rate_date:gte","in":"query","required":false,"schemaId":"schema_99"},{"name":"exchange_rate_date:lte","in":"query","required":false,"schemaId":"schema_100"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/exchange-rate","href":"use-case-accounting/list_exchange_rates_v1_accounting_exchange_rate_get","openApiOperationId":"List_exchange_rates_v1_accounting_exchange_rate_get","summary":"List Exchange Rates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListExchangeRateOutput"}},"schemaId":"components/schemas/ListExchangeRateOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1exchange-rate/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListExchangeRateOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListExchangeRateOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-accounting/list_exchange_rates_v1_accounting_exchange_rate_get"}],"panels":[]}]},"httpPath":"/v1/accounting/exchange-rate"},{"label":"Retrieve Purchase Credit Note","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-accounting/retrieve_purchase_credit_note_v1_accounting_purchase_credit_note__id__get","routeSlug":"/docs/use-case-accounting/retrieve_purchase_credit_note_v1_accounting_purchase_credit_note__id__get","metadata":{"seo":{"title":"Retrieve Purchase Credit Note","description":"Retrieve Purchase Credit Note"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Retrieve_purchase_credit_note_v1_accounting_purchase_credit_note__id__get","name":"Retrieve Purchase Credit Note","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1purchase-credit-note~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Purchase Credit Note","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1purchase-credit-note~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/purchase-credit-note/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/purchase-credit-note/{id}","href":"use-case-accounting/retrieve_purchase_credit_note_v1_accounting_purchase_credit_note__id__get","openApiOperationId":"Retrieve_purchase_credit_note_v1_accounting_purchase_credit_note__id__get","summary":"Retrieve Purchase Credit Note"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchaseCreditNote"}},"schemaId":"components/schemas/PurchaseCreditNote"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1purchase-credit-note~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PurchaseCreditNote","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchaseCreditNote"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-accounting/retrieve_purchase_credit_note_v1_accounting_purchase_credit_note__id__get"}],"panels":[]}]},"httpPath":"/v1/accounting/purchase-credit-note/{id}"},{"label":"Update Purchase Credit Note","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-accounting/update_purchase_credit_note_v1_accounting_purchase_credit_note__id__patch","routeSlug":"/docs/use-case-accounting/update_purchase_credit_note_v1_accounting_purchase_credit_note__id__patch","metadata":{"seo":{"title":"Update Purchase Credit Note","description":"Update Purchase Credit Note"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update_purchase_credit_note_v1_accounting_purchase_credit_note__id__patch","name":"Update Purchase Credit Note","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1purchase-credit-note~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Purchase Credit Note","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1purchase-credit-note~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PurchaseCreditNoteInput"}},"schemaId":"components/schemas/PurchaseCreditNoteInput","pointer":"/paths/~1v1~1accounting~1purchase-credit-note~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/accounting/purchase-credit-note/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PurchaseCreditNoteInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/purchase-credit-note/{id}","href":"use-case-accounting/update_purchase_credit_note_v1_accounting_purchase_credit_note__id__patch","openApiOperationId":"Update_purchase_credit_note_v1_accounting_purchase_credit_note__id__patch","summary":"Update Purchase Credit Note"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/PurchaseCreditNoteInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PurchaseCreditNoteInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchaseCreditNote"}},"schemaId":"components/schemas/PurchaseCreditNote"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1purchase-credit-note~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PurchaseCreditNote","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchaseCreditNote"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-accounting/update_purchase_credit_note_v1_accounting_purchase_credit_note__id__patch"}],"panels":[]}]},"httpPath":"/v1/accounting/purchase-credit-note/{id}"},{"label":"Retrieve Purchase Credit Note Documents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-accounting/retrieve_purchase_credit_note_documents_v1_accounting_purchase_credit_note__id__documents_get","routeSlug":"/docs/use-case-accounting/retrieve_purchase_credit_note_documents_v1_accounting_purchase_credit_note__id__documents_get","metadata":{"seo":{"title":"Retrieve Purchase Credit Note Documents","description":"Retrieve Purchase Credit Note Documents"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Retrieve_purchase_credit_note_documents_v1_accounting_purchase_credit_note__id__documents_get","name":"Retrieve Purchase Credit Note Documents","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1purchase-credit-note~1{id}~1documents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Purchase Credit Note Documents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1purchase-credit-note~1{id}~1documents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/purchase-credit-note/{id}/documents","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/purchase-credit-note/{id}/documents","href":"use-case-accounting/retrieve_purchase_credit_note_documents_v1_accounting_purchase_credit_note__id__documents_get","openApiOperationId":"Retrieve_purchase_credit_note_documents_v1_accounting_purchase_credit_note__id__documents_get","summary":"Retrieve Purchase Credit Note Documents"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1purchase-credit-note~1{id}~1documents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-accounting/retrieve_purchase_credit_note_documents_v1_accounting_purchase_credit_note__id__documents_get"}],"panels":[]}]},"httpPath":"/v1/accounting/purchase-credit-note/{id}/documents"},{"label":"Report Refund Status For Purchase Credit Note","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-accounting/report_refund_status_for_purchase_credit_note_v1_accounting_purchase_credit_note__id__refund_update_status_post","routeSlug":"/docs/use-case-accounting/report_refund_status_for_purchase_credit_note_v1_accounting_purchase_credit_note__id__refund_update_status_post","metadata":{"seo":{"title":"Report Refund Status For Purchase Credit Note","description":"Report Refund Status For Purchase Credit Note"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Report_refund_status_for_purchase_credit_note_v1_accounting_purchase_credit_note__id__refund_update_status_post","name":"Report Refund Status For Purchase Credit Note","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1purchase-credit-note~1{id}~1refund~1update-status/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Report Refund Status For Purchase Credit Note","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1purchase-credit-note~1{id}~1refund~1update-status/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RefundStatusUpdate"}},"schemaId":"components/schemas/RefundStatusUpdate","pointer":"/paths/~1v1~1accounting~1purchase-credit-note~1{id}~1refund~1update-status/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/accounting/purchase-credit-note/{id}/refund/update-status","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RefundStatusUpdate"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/purchase-credit-note/{id}/refund/update-status","href":"use-case-accounting/report_refund_status_for_purchase_credit_note_v1_accounting_purchase_credit_note__id__refund_update_status_post","openApiOperationId":"Report_refund_status_for_purchase_credit_note_v1_accounting_purchase_credit_note__id__refund_update_status_post","summary":"Report Refund Status For Purchase Credit Note"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/RefundStatusUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RefundStatusUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RefundStatusUpdate"}},"schemaId":"components/schemas/RefundStatusUpdate"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1purchase-credit-note~1{id}~1refund~1update-status/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RefundStatusUpdate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RefundStatusUpdate"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-accounting/report_refund_status_for_purchase_credit_note_v1_accounting_purchase_credit_note__id__refund_update_status_post"}],"panels":[]}]},"httpPath":"/v1/accounting/purchase-credit-note/{id}/refund/update-status"},{"label":"Retrieve Purchase Invoice","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-accounting/retrieve_purchase_invoice_v1_accounting_purchase_invoice__id__get","routeSlug":"/docs/use-case-accounting/retrieve_purchase_invoice_v1_accounting_purchase_invoice__id__get","metadata":{"seo":{"title":"Retrieve Purchase Invoice","description":"Retrieve Purchase Invoice"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Retrieve_purchase_invoice_v1_accounting_purchase_invoice__id__get","name":"Retrieve Purchase Invoice","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1purchase-invoice~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Purchase Invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1purchase-invoice~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/purchase-invoice/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/purchase-invoice/{id}","href":"use-case-accounting/retrieve_purchase_invoice_v1_accounting_purchase_invoice__id__get","openApiOperationId":"Retrieve_purchase_invoice_v1_accounting_purchase_invoice__id__get","summary":"Retrieve Purchase Invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchaseInvoice"}},"schemaId":"components/schemas/PurchaseInvoice"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1purchase-invoice~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PurchaseInvoice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchaseInvoice"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-accounting/retrieve_purchase_invoice_v1_accounting_purchase_invoice__id__get"}],"panels":[]}]},"httpPath":"/v1/accounting/purchase-invoice/{id}"},{"label":"Update Purchase Invoice","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-accounting/update_purchase_invoice_v1_accounting_purchase_invoice__id__patch","routeSlug":"/docs/use-case-accounting/update_purchase_invoice_v1_accounting_purchase_invoice__id__patch","metadata":{"seo":{"title":"Update Purchase Invoice","description":"Update Purchase Invoice"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update_purchase_invoice_v1_accounting_purchase_invoice__id__patch","name":"Update Purchase Invoice","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1purchase-invoice~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Purchase Invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1purchase-invoice~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PurchaseInvoiceInput"}},"schemaId":"components/schemas/PurchaseInvoiceInput","pointer":"/paths/~1v1~1accounting~1purchase-invoice~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/accounting/purchase-invoice/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PurchaseInvoiceInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/purchase-invoice/{id}","href":"use-case-accounting/update_purchase_invoice_v1_accounting_purchase_invoice__id__patch","openApiOperationId":"Update_purchase_invoice_v1_accounting_purchase_invoice__id__patch","summary":"Update Purchase Invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/PurchaseInvoiceInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PurchaseInvoiceInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchaseInvoice"}},"schemaId":"components/schemas/PurchaseInvoice"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1purchase-invoice~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PurchaseInvoice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchaseInvoice"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-accounting/update_purchase_invoice_v1_accounting_purchase_invoice__id__patch"}],"panels":[]}]},"httpPath":"/v1/accounting/purchase-invoice/{id}"},{"label":"Retrieve Purchase Invoice Documents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-accounting/retrieve_purchase_invoice_documents_v1_accounting_purchase_invoice__id__documents_get","routeSlug":"/docs/use-case-accounting/retrieve_purchase_invoice_documents_v1_accounting_purchase_invoice__id__documents_get","metadata":{"seo":{"title":"Retrieve Purchase Invoice Documents","description":"Retrieve Purchase Invoice Documents"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Retrieve_purchase_invoice_documents_v1_accounting_purchase_invoice__id__documents_get","name":"Retrieve Purchase Invoice Documents","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1purchase-invoice~1{id}~1documents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Purchase Invoice Documents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1purchase-invoice~1{id}~1documents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/purchase-invoice/{id}/documents","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/purchase-invoice/{id}/documents","href":"use-case-accounting/retrieve_purchase_invoice_documents_v1_accounting_purchase_invoice__id__documents_get","openApiOperationId":"Retrieve_purchase_invoice_documents_v1_accounting_purchase_invoice__id__documents_get","summary":"Retrieve Purchase Invoice Documents"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_102"}},"schemaId":"schema_102"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1purchase-invoice~1{id}~1documents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_102","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_102"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-accounting/retrieve_purchase_invoice_documents_v1_accounting_purchase_invoice__id__documents_get"}],"panels":[]}]},"httpPath":"/v1/accounting/purchase-invoice/{id}/documents"},{"label":"Report Payment Status For Purchase Invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-accounting/report_payment_status_for_purchase_invoice_v1_accounting_purchase_invoice__id__payment_update_status_post","routeSlug":"/docs/use-case-accounting/report_payment_status_for_purchase_invoice_v1_accounting_purchase_invoice__id__payment_update_status_post","metadata":{"seo":{"title":"Report Payment Status For Purchase Invoice","description":"Report Payment Status For Purchase Invoice"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Report_payment_status_for_purchase_invoice_v1_accounting_purchase_invoice__id__payment_update_status_post","name":"Report Payment Status For Purchase Invoice","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1purchase-invoice~1{id}~1payment~1update-status/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Report Payment Status For Purchase Invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1purchase-invoice~1{id}~1payment~1update-status/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}},"schemaId":"components/schemas/PaymentStatusUpdate","pointer":"/paths/~1v1~1accounting~1purchase-invoice~1{id}~1payment~1update-status/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/accounting/purchase-invoice/{id}/payment/update-status","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/purchase-invoice/{id}/payment/update-status","href":"use-case-accounting/report_payment_status_for_purchase_invoice_v1_accounting_purchase_invoice__id__payment_update_status_post","openApiOperationId":"Report_payment_status_for_purchase_invoice_v1_accounting_purchase_invoice__id__payment_update_status_post","summary":"Report Payment Status For Purchase Invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/PaymentStatusUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}},"schemaId":"components/schemas/PaymentStatusUpdate"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1purchase-invoice~1{id}~1payment~1update-status/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentStatusUpdate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-accounting/report_payment_status_for_purchase_invoice_v1_accounting_purchase_invoice__id__payment_update_status_post"}],"panels":[]}]},"httpPath":"/v1/accounting/purchase-invoice/{id}/payment/update-status"},{"label":"Create A Sales Credit Note","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-accounting/create_a_sales_credit_note_v1_accounting_sales_credit_note__post","routeSlug":"/docs/use-case-accounting/create_a_sales_credit_note_v1_accounting_sales_credit_note__post","metadata":{"seo":{"title":"Create A Sales Credit Note","description":"Create A Sales Credit Note"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create_a_sales_credit_note_v1_accounting_sales_credit_note__post","name":"Create A Sales Credit Note","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sales-credit-note~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create A Sales Credit Note","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SalesCreditNoteInput"}},"schemaId":"components/schemas/SalesCreditNoteInput","pointer":"/paths/~1v1~1accounting~1sales-credit-note~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/accounting/sales-credit-note/","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SalesCreditNoteInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sales-credit-note/","href":"use-case-accounting/create_a_sales_credit_note_v1_accounting_sales_credit_note__post","openApiOperationId":"Create_a_sales_credit_note_v1_accounting_sales_credit_note__post","summary":"Create A Sales Credit Note"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/SalesCreditNoteInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SalesCreditNoteInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SalesCreditNoteOutput"}},"schemaId":"components/schemas/SalesCreditNoteOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sales-credit-note~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SalesCreditNoteOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SalesCreditNoteOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-accounting/create_a_sales_credit_note_v1_accounting_sales_credit_note__post"}],"panels":[]}]},"httpPath":"/v1/accounting/sales-credit-note/"},{"label":"Retrieve Sales Credit Note","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-accounting/retrieve_sales_credit_note_v1_accounting_sales_credit_note__id__get","routeSlug":"/docs/use-case-accounting/retrieve_sales_credit_note_v1_accounting_sales_credit_note__id__get","metadata":{"seo":{"title":"Retrieve Sales Credit Note","description":"Retrieve Sales Credit Note"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Retrieve_sales_credit_note_v1_accounting_sales_credit_note__id__get","name":"Retrieve Sales Credit Note","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sales-credit-note~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Sales Credit Note","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1sales-credit-note~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/sales-credit-note/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sales-credit-note/{id}","href":"use-case-accounting/retrieve_sales_credit_note_v1_accounting_sales_credit_note__id__get","openApiOperationId":"Retrieve_sales_credit_note_v1_accounting_sales_credit_note__id__get","summary":"Retrieve Sales Credit Note"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SalesCreditNoteOutput"}},"schemaId":"components/schemas/SalesCreditNoteOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sales-credit-note~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SalesCreditNoteOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SalesCreditNoteOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-accounting/retrieve_sales_credit_note_v1_accounting_sales_credit_note__id__get"}],"panels":[]}]},"httpPath":"/v1/accounting/sales-credit-note/{id}"},{"label":"Update Credit Note","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-accounting/update_credit_note_v1_accounting_sales_credit_note__id__patch","routeSlug":"/docs/use-case-accounting/update_credit_note_v1_accounting_sales_credit_note__id__patch","metadata":{"seo":{"title":"Update Credit Note","description":"Update Credit Note"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update_credit_note_v1_accounting_sales_credit_note__id__patch","name":"Update Credit Note","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sales-credit-note~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Credit Note","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1sales-credit-note~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SalesCreditNotePatchInput"}},"schemaId":"components/schemas/SalesCreditNotePatchInput","pointer":"/paths/~1v1~1accounting~1sales-credit-note~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/accounting/sales-credit-note/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SalesCreditNotePatchInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sales-credit-note/{id}","href":"use-case-accounting/update_credit_note_v1_accounting_sales_credit_note__id__patch","openApiOperationId":"Update_credit_note_v1_accounting_sales_credit_note__id__patch","summary":"Update Credit Note"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/SalesCreditNotePatchInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SalesCreditNotePatchInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SalesCreditNoteOutput"}},"schemaId":"components/schemas/SalesCreditNoteOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sales-credit-note~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SalesCreditNoteOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SalesCreditNoteOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-accounting/update_credit_note_v1_accounting_sales_credit_note__id__patch"}],"panels":[]}]},"httpPath":"/v1/accounting/sales-credit-note/{id}"},{"label":"Retrieve Sales Credit Note Documents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-accounting/retrieve_sales_credit_note_documents_v1_accounting_sales_credit_note__id__documents_get","routeSlug":"/docs/use-case-accounting/retrieve_sales_credit_note_documents_v1_accounting_sales_credit_note__id__documents_get","metadata":{"seo":{"title":"Retrieve Sales Credit Note Documents","description":"Retrieve Sales Credit Note Documents"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Retrieve_sales_credit_note_documents_v1_accounting_sales_credit_note__id__documents_get","name":"Retrieve Sales Credit Note Documents","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sales-credit-note~1{id}~1documents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Sales Credit Note Documents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1sales-credit-note~1{id}~1documents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/sales-credit-note/{id}/documents","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sales-credit-note/{id}/documents","href":"use-case-accounting/retrieve_sales_credit_note_documents_v1_accounting_sales_credit_note__id__documents_get","openApiOperationId":"Retrieve_sales_credit_note_documents_v1_accounting_sales_credit_note__id__documents_get","summary":"Retrieve Sales Credit Note Documents"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_103"}},"schemaId":"schema_103"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sales-credit-note~1{id}~1documents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_103","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_103"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-accounting/retrieve_sales_credit_note_documents_v1_accounting_sales_credit_note__id__documents_get"}],"panels":[]}]},"httpPath":"/v1/accounting/sales-credit-note/{id}/documents"},{"label":"Report Refund Status For Sales Credit Note","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-accounting/report_refund_status_for_sales_credit_note_v1_accounting_sales_credit_note__id__refund_update_status_post","routeSlug":"/docs/use-case-accounting/report_refund_status_for_sales_credit_note_v1_accounting_sales_credit_note__id__refund_update_status_post","metadata":{"seo":{"title":"Report Refund Status For Sales Credit Note","description":"Report Refund Status For Sales Credit Note"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Report_refund_status_for_sales_credit_note_v1_accounting_sales_credit_note__id__refund_update_status_post","name":"Report Refund Status For Sales Credit Note","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sales-credit-note~1{id}~1refund~1update-status/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Report Refund Status For Sales Credit Note","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1sales-credit-note~1{id}~1refund~1update-status/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RefundStatusUpdate"}},"schemaId":"components/schemas/RefundStatusUpdate","pointer":"/paths/~1v1~1accounting~1sales-credit-note~1{id}~1refund~1update-status/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/accounting/sales-credit-note/{id}/refund/update-status","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RefundStatusUpdate"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sales-credit-note/{id}/refund/update-status","href":"use-case-accounting/report_refund_status_for_sales_credit_note_v1_accounting_sales_credit_note__id__refund_update_status_post","openApiOperationId":"Report_refund_status_for_sales_credit_note_v1_accounting_sales_credit_note__id__refund_update_status_post","summary":"Report Refund Status For Sales Credit Note"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/RefundStatusUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RefundStatusUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RefundStatusUpdate"}},"schemaId":"components/schemas/RefundStatusUpdate"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sales-credit-note~1{id}~1refund~1update-status/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RefundStatusUpdate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RefundStatusUpdate"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-accounting/report_refund_status_for_sales_credit_note_v1_accounting_sales_credit_note__id__refund_update_status_post"}],"panels":[]}]},"httpPath":"/v1/accounting/sales-credit-note/{id}/refund/update-status"},{"label":"Create A Sales Invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-accounting/create_a_sales_invoice_v1_accounting_sales_invoice__post","routeSlug":"/docs/use-case-accounting/create_a_sales_invoice_v1_accounting_sales_invoice__post","metadata":{"seo":{"title":"Create A Sales Invoice","description":"Create A Sales Invoice"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create_a_sales_invoice_v1_accounting_sales_invoice__post","name":"Create A Sales Invoice","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sales-invoice~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create A Sales Invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SalesInvoiceInput"}},"schemaId":"components/schemas/SalesInvoiceInput","pointer":"/paths/~1v1~1accounting~1sales-invoice~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/accounting/sales-invoice/","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SalesInvoiceInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sales-invoice/","href":"use-case-accounting/create_a_sales_invoice_v1_accounting_sales_invoice__post","openApiOperationId":"Create_a_sales_invoice_v1_accounting_sales_invoice__post","summary":"Create A Sales Invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/SalesInvoiceInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SalesInvoiceInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SalesInvoiceOutput"}},"schemaId":"components/schemas/SalesInvoiceOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sales-invoice~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SalesInvoiceOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SalesInvoiceOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-accounting/create_a_sales_invoice_v1_accounting_sales_invoice__post"}],"panels":[]}]},"httpPath":"/v1/accounting/sales-invoice/"},{"label":"Retrieve Sales Invoice","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-accounting/retrieve_sales_invoice_v1_accounting_sales_invoice__id__get","routeSlug":"/docs/use-case-accounting/retrieve_sales_invoice_v1_accounting_sales_invoice__id__get","metadata":{"seo":{"title":"Retrieve Sales Invoice","description":"Retrieve Sales Invoice"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Retrieve_sales_invoice_v1_accounting_sales_invoice__id__get","name":"Retrieve Sales Invoice","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sales-invoice~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Sales Invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1sales-invoice~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/sales-invoice/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sales-invoice/{id}","href":"use-case-accounting/retrieve_sales_invoice_v1_accounting_sales_invoice__id__get","openApiOperationId":"Retrieve_sales_invoice_v1_accounting_sales_invoice__id__get","summary":"Retrieve Sales Invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SalesInvoiceOutput"}},"schemaId":"components/schemas/SalesInvoiceOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sales-invoice~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SalesInvoiceOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SalesInvoiceOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-accounting/retrieve_sales_invoice_v1_accounting_sales_invoice__id__get"}],"panels":[]}]},"httpPath":"/v1/accounting/sales-invoice/{id}"},{"label":"Update Sales Invoice","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-accounting/update_sales_invoice_v1_accounting_sales_invoice__id__patch","routeSlug":"/docs/use-case-accounting/update_sales_invoice_v1_accounting_sales_invoice__id__patch","metadata":{"seo":{"title":"Update Sales Invoice","description":"Update Sales Invoice"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update_sales_invoice_v1_accounting_sales_invoice__id__patch","name":"Update Sales Invoice","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sales-invoice~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Sales Invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1sales-invoice~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SalesInvoicePatchInput"}},"schemaId":"components/schemas/SalesInvoicePatchInput","pointer":"/paths/~1v1~1accounting~1sales-invoice~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/accounting/sales-invoice/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SalesInvoicePatchInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sales-invoice/{id}","href":"use-case-accounting/update_sales_invoice_v1_accounting_sales_invoice__id__patch","openApiOperationId":"Update_sales_invoice_v1_accounting_sales_invoice__id__patch","summary":"Update Sales Invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/SalesInvoicePatchInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SalesInvoicePatchInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SalesInvoiceOutput"}},"schemaId":"components/schemas/SalesInvoiceOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sales-invoice~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SalesInvoiceOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SalesInvoiceOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-accounting/update_sales_invoice_v1_accounting_sales_invoice__id__patch"}],"panels":[]}]},"httpPath":"/v1/accounting/sales-invoice/{id}"},{"label":"Retrieve Sales Invoice Documents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-accounting/retrieve_sales_invoice_documents_v1_accounting_sales_invoice__id__documents_get","routeSlug":"/docs/use-case-accounting/retrieve_sales_invoice_documents_v1_accounting_sales_invoice__id__documents_get","metadata":{"seo":{"title":"Retrieve Sales Invoice Documents","description":"Retrieve Sales Invoice Documents"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Retrieve_sales_invoice_documents_v1_accounting_sales_invoice__id__documents_get","name":"Retrieve Sales Invoice Documents","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sales-invoice~1{id}~1documents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Sales Invoice Documents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1sales-invoice~1{id}~1documents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/sales-invoice/{id}/documents","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sales-invoice/{id}/documents","href":"use-case-accounting/retrieve_sales_invoice_documents_v1_accounting_sales_invoice__id__documents_get","openApiOperationId":"Retrieve_sales_invoice_documents_v1_accounting_sales_invoice__id__documents_get","summary":"Retrieve Sales Invoice Documents"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_104"}},"schemaId":"schema_104"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sales-invoice~1{id}~1documents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_104","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_104"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-accounting/retrieve_sales_invoice_documents_v1_accounting_sales_invoice__id__documents_get"}],"panels":[]}]},"httpPath":"/v1/accounting/sales-invoice/{id}/documents"},{"label":"Report Payment Status For Sales Invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-accounting/report_payment_status_for_sales_invoice_v1_accounting_sales_invoice__id__payment_update_status_post","routeSlug":"/docs/use-case-accounting/report_payment_status_for_sales_invoice_v1_accounting_sales_invoice__id__payment_update_status_post","metadata":{"seo":{"title":"Report Payment Status For Sales Invoice","description":"Report Payment Status For Sales Invoice"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Report_payment_status_for_sales_invoice_v1_accounting_sales_invoice__id__payment_update_status_post","name":"Report Payment Status For Sales Invoice","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sales-invoice~1{id}~1payment~1update-status/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Report Payment Status For Sales Invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1sales-invoice~1{id}~1payment~1update-status/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}},"schemaId":"components/schemas/PaymentStatusUpdate","pointer":"/paths/~1v1~1accounting~1sales-invoice~1{id}~1payment~1update-status/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/accounting/sales-invoice/{id}/payment/update-status","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sales-invoice/{id}/payment/update-status","href":"use-case-accounting/report_payment_status_for_sales_invoice_v1_accounting_sales_invoice__id__payment_update_status_post","openApiOperationId":"Report_payment_status_for_sales_invoice_v1_accounting_sales_invoice__id__payment_update_status_post","summary":"Report Payment Status For Sales Invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/PaymentStatusUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}},"schemaId":"components/schemas/PaymentStatusUpdate"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sales-invoice~1{id}~1payment~1update-status/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentStatusUpdate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-accounting/report_payment_status_for_sales_invoice_v1_accounting_sales_invoice__id__payment_update_status_post"}],"panels":[]}]},"httpPath":"/v1/accounting/sales-invoice/{id}/payment/update-status"},{"label":"List Invoices/Credit Notes To Sync","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-accounting/list_invoices_credit_notes_to_sync_v1_accounting_sync_tasks_get","routeSlug":"/docs/use-case-accounting/list_invoices_credit_notes_to_sync_v1_accounting_sync_tasks_get","metadata":{"seo":{"title":"List Invoices/Credit Notes To Sync","description":"List Invoices/Credit Notes To Sync"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"List_invoices_credit_notes_to_sync_v1_accounting_sync_tasks_get","name":"List Invoices/Credit Notes To Sync","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sync-tasks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Invoices/Credit Notes To Sync","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"billing_entity_code","in":"query","schemaId":"schema_91","description":"Billing entity code to filter tasks, useful if multiple billing entities are linked to the same integration"}],"pointer":"/paths/~1v1~1accounting~1sync-tasks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/sync-tasks","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[{"name":"billing_entity_code","in":"query","required":false,"schemaId":"schema_91"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sync-tasks","href":"use-case-accounting/list_invoices_credit_notes_to_sync_v1_accounting_sync_tasks_get","openApiOperationId":"List_invoices_credit_notes_to_sync_v1_accounting_sync_tasks_get","summary":"List Invoices/Credit Notes To Sync"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AvailableTasks"}},"schemaId":"components/schemas/AvailableTasks"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sync-tasks/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AvailableTasks","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AvailableTasks"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-accounting/list_invoices_credit_notes_to_sync_v1_accounting_sync_tasks_get"}],"panels":[]}]},"httpPath":"/v1/accounting/sync-tasks"},{"label":"Get Details Of Invoice/Credit Note To Sync","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-accounting/get_details_of_invoice_credit_note_to_sync_v1_accounting_sync_tasks__id__get","routeSlug":"/docs/use-case-accounting/get_details_of_invoice_credit_note_to_sync_v1_accounting_sync_tasks__id__get","metadata":{"seo":{"title":"Get Details Of Invoice/Credit Note To Sync","description":"Get Details Of Invoice/Credit Note To Sync"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get_details_of_Invoice_Credit_note_to_sync_v1_accounting_sync_tasks__id__get","name":"Get Details Of Invoice/Credit Note To Sync","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sync-tasks~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Details Of Invoice/Credit Note To Sync","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1sync-tasks~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/sync-tasks/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sync-tasks/{id}","href":"use-case-accounting/get_details_of_invoice_credit_note_to_sync_v1_accounting_sync_tasks__id__get","openApiOperationId":"Get_details_of_Invoice_Credit_note_to_sync_v1_accounting_sync_tasks__id__get","summary":"Get Details Of Invoice/Credit Note To Sync"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaskDetail"}},"schemaId":"components/schemas/TaskDetail"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sync-tasks~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TaskDetail","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaskDetail"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-accounting/get_details_of_invoice_credit_note_to_sync_v1_accounting_sync_tasks__id__get"}],"panels":[]}]},"httpPath":"/v1/accounting/sync-tasks/{id}"},{"label":"Report Sync Status For Invoice/Credit Note","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-accounting/report_sync_status_for_invoice_credit_note_v1_accounting_sync_tasks__id__update_status_post","routeSlug":"/docs/use-case-accounting/report_sync_status_for_invoice_credit_note_v1_accounting_sync_tasks__id__update_status_post","metadata":{"seo":{"title":"Report Sync Status For Invoice/Credit Note","description":"Reports the sync status for an invoice/credit note task. No billing_entity_code is required."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Report_sync_status_for_invoice_credit_note_v1_accounting_sync_tasks__id__update_status_post","name":"Report Sync Status For Invoice/Credit Note","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sync-tasks~1{id}~1update-status/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Report Sync Status For Invoice/Credit Note","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":"Reports the sync status for an invoice/credit note task. No billing_entity_code is required."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1sync-tasks~1{id}~1update-status/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TaskUpdateInput"}},"schemaId":"components/schemas/TaskUpdateInput","pointer":"/paths/~1v1~1accounting~1sync-tasks~1{id}~1update-status/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/accounting/sync-tasks/{id}/update-status","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TaskUpdateInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sync-tasks/{id}/update-status","href":"use-case-accounting/report_sync_status_for_invoice_credit_note_v1_accounting_sync_tasks__id__update_status_post","openApiOperationId":"Report_sync_status_for_invoice_credit_note_v1_accounting_sync_tasks__id__update_status_post","summary":"Report Sync Status For Invoice/Credit Note"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/TaskUpdateInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TaskUpdateInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaskUpdate"}},"schemaId":"components/schemas/TaskUpdate"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sync-tasks~1{id}~1update-status/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TaskUpdate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaskUpdate"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-accounting/report_sync_status_for_invoice_credit_note_v1_accounting_sync_tasks__id__update_status_post"}],"panels":[]}]},"httpPath":"/v1/accounting/sync-tasks/{id}/update-status"},{"label":"List Tax Rates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-accounting/list_tax_rates_v1_accounting_tax_rates_get","routeSlug":"/docs/use-case-accounting/list_tax_rates_v1_accounting_tax_rates_get","metadata":{"seo":{"title":"List Tax Rates","description":"Lists tax rates for the tenant, with optional filtering and pagination."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"List_tax_rates_v1_accounting_tax_rates_get","name":"List Tax Rates","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1tax-rates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Tax Rates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists tax rates for the tenant, with optional filtering and pagination."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_89","description":"Pagination cursor. Mutually exclusive with other query parameters"},{"name":"archived","in":"query","schemaId":"schema_90","description":"Filter by archived status. Omit to return all tax rates."},{"name":"billing_entity_code","in":"query","schemaId":"schema_91","description":"Filter by billing entity code."},{"name":"code","in":"query","schemaId":"schema_92","description":"Tax rate code to match exactly."},{"name":"code:in","in":"query","schemaId":"schema_93","description":"Tax rate codes to match. Comma-separated list."}],"pointer":"/paths/~1v1~1accounting~1tax-rates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/tax-rates","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_89"},{"name":"archived","in":"query","required":false,"schemaId":"schema_90"},{"name":"billing_entity_code","in":"query","required":false,"schemaId":"schema_91"},{"name":"code","in":"query","required":false,"schemaId":"schema_92"},{"name":"code:in","in":"query","required":false,"schemaId":"schema_93"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/tax-rates","href":"use-case-accounting/list_tax_rates_v1_accounting_tax_rates_get","openApiOperationId":"List_tax_rates_v1_accounting_tax_rates_get","summary":"List Tax Rates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListTaxRateOutput"}},"schemaId":"components/schemas/ListTaxRateOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1tax-rates/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListTaxRateOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListTaxRateOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-accounting/list_tax_rates_v1_accounting_tax_rates_get"}],"panels":[]}]},"httpPath":"/v1/accounting/tax-rates"},{"label":"Retrieve Tax Rate","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-accounting/retrieve_tax_rate_v1_accounting_tax_rates__id__get","routeSlug":"/docs/use-case-accounting/retrieve_tax_rate_v1_accounting_tax_rates__id__get","metadata":{"seo":{"title":"Retrieve Tax Rate","description":"Retrieves a single tax rate by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Retrieve_tax_rate_v1_accounting_tax_rates__id__get","name":"Retrieve Tax Rate","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1tax-rates~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Tax Rate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a single tax rate by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1tax-rates~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/tax-rates/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/tax-rates/{id}","href":"use-case-accounting/retrieve_tax_rate_v1_accounting_tax_rates__id__get","openApiOperationId":"Retrieve_tax_rate_v1_accounting_tax_rates__id__get","summary":"Retrieve Tax Rate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaxRateOutput"}},"schemaId":"components/schemas/TaxRateOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1tax-rates~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TaxRateOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaxRateOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-accounting/retrieve_tax_rate_v1_accounting_tax_rates__id__get"}],"panels":[]}]},"httpPath":"/v1/accounting/tax-rates/{id}"},{"label":"Download Document","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-accounting/download_document_v1_documents_document__id__download_get","routeSlug":"/docs/use-case-accounting/download_document_v1_documents_document__id__download_get","metadata":{"seo":{"title":"Download Document","description":"Download a document by its ID. You can choose to download the document directly or stream it."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"download_document_v1_documents_document__id__download_get","name":"Download Document","isWebhook":false,"pointer":"/paths/~1v1~1documents~1document~1{id}~1download/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download Document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Download a document by its ID. You can choose to download the document directly or stream it."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1documents~1document~1{id}~1download/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"direct","in":"query","schemaId":"schema_105","description":"Query parameter to indicate that the response should contain all the document bytes"}],"pointer":"/paths/~1v1~1documents~1document~1{id}~1download/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/documents/document/{id}/download","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[{"name":"direct","in":"query","required":false,"schemaId":"schema_105"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/documents/document/{id}/download","href":"use-case-accounting/download_document_v1_documents_document__id__download_get","openApiOperationId":"download_document_v1_documents_document__id__download_get","summary":"Download Document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}},"schemaId":"schema_106"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1documents~1document~1{id}~1download/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_106","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-accounting/download_document_v1_documents_document__id__download_get"}],"panels":[]}]},"httpPath":"/v1/documents/document/{id}/download"},{"label":"External Billing Document (Invoice/Credit-Note) Update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-accounting/billing-document-update-webhook","routeSlug":"/docs/use-case-accounting/billing-document-update-webhook","metadata":{"seo":{"title":"External Billing Document (Invoice/Credit-Note) Update","description":"Update billing document metadata (invoices, credit notes) from an external accounting system."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"billing-document-update-webhook","name":"External Billing Document (Invoice/Credit-Note) Update","isWebhook":false,"pointer":"/paths/~1v1~1webhook~1billing-document-update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"External Billing Document (Invoice/Credit-Note) Update","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":"Update billing document metadata (invoices, credit notes) from an external accounting system."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This webhook uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Basic Auth"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (webhook credentials), not the OAuth credentials used for the API."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact integrations@qargo.com to request credentials."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint to push document status changes or related metadata updates back to Qargo."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is typically triggered when your external accounting system processes billing documents."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuthWebhookCredentials","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BillingDocumentUpdatePayload"}},"schemaId":"components/schemas/BillingDocumentUpdatePayload","pointer":"/paths/~1v1~1webhook~1billing-document-update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/webhook/billing-document-update","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuthWebhookCredentials","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BillingDocumentUpdatePayload"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/webhook/billing-document-update","href":"use-case-accounting/billing-document-update-webhook","openApiOperationId":"billing-document-update-webhook","summary":"External Billing Document (Invoice/Credit-Note) Update"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/BillingDocumentUpdatePayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BillingDocumentUpdatePayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}},"schemaId":"schema_106"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1webhook~1billing-document-update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_106","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-accounting/billing-document-update-webhook"}],"panels":[]}]},"httpPath":"/v1/webhook/billing-document-update"},{"label":"Accounting Visibility Event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-accounting/accounting_visibility_eventhttps____accounting_visibility_event_receiving_payload__post","routeSlug":"/docs/use-case-accounting/accounting_visibility_eventhttps____accounting_visibility_event_receiving_payload__post","metadata":{"seo":{"title":"Accounting Visibility Event","description":"Webhook for updates to orders and trips. Subscribe to this endpoint to receive updates."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Accounting_visibility_eventhttps____accounting_visibility_event_receiving_payload__post","name":"Accounting Visibility Event","isWebhook":false,"pointer":"/paths/https:~1~1<accounting-visibility-event-receiving-payload>/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Accounting Visibility Event","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Webhook for updates to orders and trips. Subscribe to this endpoint to receive updates.\n\nNote that both support our canonical VisibilityUpdate schema,\nbut the body can also be a custom mapped format."},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_107"}},"schemaId":"schema_107","pointer":"/paths/https:~1~1<accounting-visibility-event-receiving-payload>/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"https://<accounting-visibility-event-receiving-payload>","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_107"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"https://<accounting-visibility-event-receiving-payload>","href":"use-case-accounting/accounting_visibility_eventhttps____accounting_visibility_event_receiving_payload__post","openApiOperationId":"Accounting_visibility_eventhttps____accounting_visibility_event_receiving_payload__post","summary":"Accounting Visibility Event"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"schema_107","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_107"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}},"schemaId":"schema_106"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/https:~1~1<accounting-visibility-event-receiving-payload>/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_106","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-accounting/accounting_visibility_eventhttps____accounting_visibility_event_receiving_payload__post"}],"panels":[]}]},"httpPath":"https://<accounting-visibility-event-receiving-payload>"},{"label":"List Companies (Deprecated)","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-accounting/list_companies__deprecated__v1_accounting_company_get","routeSlug":"/docs/use-case-accounting/list_companies__deprecated__v1_accounting_company_get","metadata":{"seo":{"title":"List Companies (Deprecated)","description":"(deprecated, use /company instead)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_companies__deprecated__v1_accounting_company_get","name":"List Companies (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1accounting~1company/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Companies (Deprecated)","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"(deprecated, use /company instead)"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_89","description":"Pagination cursor. Mutually exclusive with other query parameters"},{"name":"updated_after","in":"query","schemaId":"schema_108","description":"Filter to fetch the companies updated after this time. Format is ISO 8601 YYYY-MM-DDTHH:MM:SSZ"},{"name":"code","in":"query","schemaId":"schema_92","description":"Company code to match exactly."},{"name":"code:in","in":"query","schemaId":"schema_93","description":"Company codes to match. Comma-separated list."},{"name":"accounting_customer_code","in":"query","schemaId":"schema_109","description":"Accounting customer code to match exactly. Holds the code of the default billing entity."},{"name":"accounting_customer_code:in","in":"query","schemaId":"schema_110","description":"Accounting customer codes to match. Comma-separated list. Holds the code of the default billing entity."}],"pointer":"/paths/~1v1~1accounting~1company/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/company","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_89"},{"name":"updated_after","in":"query","required":false,"schemaId":"schema_108"},{"name":"code","in":"query","required":false,"schemaId":"schema_92"},{"name":"code:in","in":"query","required":false,"schemaId":"schema_93"},{"name":"accounting_customer_code","in":"query","required":false,"schemaId":"schema_109"},{"name":"accounting_customer_code:in","in":"query","required":false,"schemaId":"schema_110"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/company","href":"use-case-accounting/list_companies__deprecated__v1_accounting_company_get","openApiOperationId":"list_companies__deprecated__v1_accounting_company_get","summary":"List Companies (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCompanyOutput"}},"schemaId":"components/schemas/ListCompanyOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1company/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCompanyOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCompanyOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-accounting/list_companies__deprecated__v1_accounting_company_get"}],"panels":[]}]},"httpPath":"/v1/accounting/company"},{"label":"Create Company (Deprecated)","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-accounting/create_company__deprecated__v1_accounting_company_post","routeSlug":"/docs/use-case-accounting/create_company__deprecated__v1_accounting_company_post","metadata":{"seo":{"title":"Create Company (Deprecated)","description":"(deprecated, use /company instead)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_company__deprecated__v1_accounting_company_post","name":"Create Company (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1accounting~1company/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Company (Deprecated)","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"(deprecated, use /company instead)"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyInput"}},"schemaId":"components/schemas/CompanyInput","pointer":"/paths/~1v1~1accounting~1company/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/accounting/company","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CompanyInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/company","href":"use-case-accounting/create_company__deprecated__v1_accounting_company_post","openApiOperationId":"create_company__deprecated__v1_accounting_company_post","summary":"Create Company (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/CompanyInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyDetailOutput"}},"schemaId":"components/schemas/CompanyDetailOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1company/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompanyDetailOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyDetailOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-accounting/create_company__deprecated__v1_accounting_company_post"}],"panels":[]}]},"httpPath":"/v1/accounting/company"},{"label":"Get Company (Deprecated)","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-accounting/get_company__deprecated__v1_accounting_company__id__get","routeSlug":"/docs/use-case-accounting/get_company__deprecated__v1_accounting_company__id__get","metadata":{"seo":{"title":"Get Company (Deprecated)","description":"(deprecated, use /company/{id} instead)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_company__deprecated__v1_accounting_company__id__get","name":"Get Company (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1accounting~1company~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Company (Deprecated)","isWebhook":false,"deprecated":true,"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":"(deprecated, use /company/{id} instead)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1company~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/company/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/company/{id}","href":"use-case-accounting/get_company__deprecated__v1_accounting_company__id__get","openApiOperationId":"get_company__deprecated__v1_accounting_company__id__get","summary":"Get Company (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyDetailOutput"}},"schemaId":"components/schemas/CompanyDetailOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1company~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompanyDetailOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyDetailOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-accounting/get_company__deprecated__v1_accounting_company__id__get"}],"panels":[]}]},"httpPath":"/v1/accounting/company/{id}"},{"label":"Update Company (Deprecated)","deprecated":true,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-accounting/update_company__deprecated__v1_accounting_company__id__put","routeSlug":"/docs/use-case-accounting/update_company__deprecated__v1_accounting_company__id__put","metadata":{"seo":{"title":"Update Company (Deprecated)","description":"(deprecated, use /company/{id} instead)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_company__deprecated__v1_accounting_company__id__put","name":"Update Company (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1accounting~1company~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Company (Deprecated)","isWebhook":false,"deprecated":true,"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":"(deprecated, use /company/{id} instead)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1company~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyInput"}},"schemaId":"components/schemas/CompanyInput","pointer":"/paths/~1v1~1accounting~1company~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/accounting/company/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CompanyInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/company/{id}","href":"use-case-accounting/update_company__deprecated__v1_accounting_company__id__put","openApiOperationId":"update_company__deprecated__v1_accounting_company__id__put","summary":"Update Company (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/CompanyInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyDetailOutput"}},"schemaId":"components/schemas/CompanyDetailOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1company~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompanyDetailOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyDetailOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-accounting/update_company__deprecated__v1_accounting_company__id__put"}],"panels":[]}]},"httpPath":"/v1/accounting/company/{id}"},{"label":"Update Company (Deprecated)","deprecated":true,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-accounting/update_company__deprecated__v1_accounting_company__id__patch","routeSlug":"/docs/use-case-accounting/update_company__deprecated__v1_accounting_company__id__patch","metadata":{"seo":{"title":"Update Company (Deprecated)","description":"(deprecated, use /company/{id} instead)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_company__deprecated__v1_accounting_company__id__patch","name":"Update Company (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1accounting~1company~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Company (Deprecated)","isWebhook":false,"deprecated":true,"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":"(deprecated, use /company/{id} instead)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1company~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyPartialInput"}},"schemaId":"components/schemas/CompanyPartialInput","pointer":"/paths/~1v1~1accounting~1company~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/accounting/company/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CompanyPartialInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/company/{id}","href":"use-case-accounting/update_company__deprecated__v1_accounting_company__id__patch","openApiOperationId":"update_company__deprecated__v1_accounting_company__id__patch","summary":"Update Company (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/CompanyPartialInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyPartialInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyDetailOutput"}},"schemaId":"components/schemas/CompanyDetailOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1company~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompanyDetailOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyDetailOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-accounting/update_company__deprecated__v1_accounting_company__id__patch"}],"panels":[]}]},"httpPath":"/v1/accounting/company/{id}"},{"label":"Archive Company (Deprecated)","deprecated":true,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-accounting/archive_company__deprecated__v1_accounting_company__id__delete","routeSlug":"/docs/use-case-accounting/archive_company__deprecated__v1_accounting_company__id__delete","metadata":{"seo":{"title":"Archive Company (Deprecated)","description":"Archive the company. This is a soft-delete: the company record is preserved and its archived_customer, archived_subcontractor, and archived_buyer_or_seller flags are set to true so it no longer appears in active lists.(deprecated, use /company/{id} instead)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Archive_company__deprecated__v1_accounting_company__id__delete","name":"Archive Company (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1accounting~1company~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Archive Company (Deprecated)","isWebhook":false,"deprecated":true,"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":"Archive the company. This is a soft-delete: the company record is preserved and its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"archived_customer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"archived_subcontractor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"archived_buyer_or_seller"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flags are set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" so it no longer appears in active lists.(deprecated, use /company/{id} instead)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1company~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/accounting/company/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/company/{id}","href":"use-case-accounting/archive_company__deprecated__v1_accounting_company__id__delete","openApiOperationId":"Archive_company__deprecated__v1_accounting_company__id__delete","summary":"Archive Company (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}},"schemaId":"schema_106"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1company~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_106","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-accounting/archive_company__deprecated__v1_accounting_company__id__delete"}],"panels":[]}]},"httpPath":"/v1/accounting/company/{id}"},{"label":"Retrieve Purchase Invoice (Deprecated)","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-accounting/retrieve_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__get","routeSlug":"/docs/use-case-accounting/retrieve_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__get","metadata":{"seo":{"title":"Retrieve Purchase Invoice (Deprecated)","description":"(deprecated, use /purchase-invoice/{id} instead)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Retrieve_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__get","name":"Retrieve Purchase Invoice (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1accounting~1purchase_invoice~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Purchase Invoice (Deprecated)","isWebhook":false,"deprecated":true,"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":"(deprecated, use /purchase-invoice/{id} instead)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1purchase_invoice~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/purchase_invoice/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/purchase_invoice/{id}","href":"use-case-accounting/retrieve_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__get","openApiOperationId":"Retrieve_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__get","summary":"Retrieve Purchase Invoice (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchaseInvoice"}},"schemaId":"components/schemas/PurchaseInvoice"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1purchase_invoice~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PurchaseInvoice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchaseInvoice"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-accounting/retrieve_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__get"}],"panels":[]}]},"httpPath":"/v1/accounting/purchase_invoice/{id}"},{"label":"Update Purchase Invoice (Deprecated)","deprecated":true,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-accounting/update_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__patch","routeSlug":"/docs/use-case-accounting/update_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__patch","metadata":{"seo":{"title":"Update Purchase Invoice (Deprecated)","description":"(deprecated, use /purchase-invoice/{id} instead)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__patch","name":"Update Purchase Invoice (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1accounting~1purchase_invoice~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Purchase Invoice (Deprecated)","isWebhook":false,"deprecated":true,"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":"(deprecated, use /purchase-invoice/{id} instead)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1purchase_invoice~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PurchaseInvoiceInput"}},"schemaId":"components/schemas/PurchaseInvoiceInput","pointer":"/paths/~1v1~1accounting~1purchase_invoice~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/accounting/purchase_invoice/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PurchaseInvoiceInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/purchase_invoice/{id}","href":"use-case-accounting/update_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__patch","openApiOperationId":"Update_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__patch","summary":"Update Purchase Invoice (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/PurchaseInvoiceInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PurchaseInvoiceInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchaseInvoice"}},"schemaId":"components/schemas/PurchaseInvoice"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1purchase_invoice~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PurchaseInvoice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchaseInvoice"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-accounting/update_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__patch"}],"panels":[]}]},"httpPath":"/v1/accounting/purchase_invoice/{id}"},{"label":"Retrieve Purchase Invoice Documents (Deprecated)","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-accounting/retrieve_purchase_invoice_documents__deprecated__v1_accounting_purchase_invoice__id__documents_get","routeSlug":"/docs/use-case-accounting/retrieve_purchase_invoice_documents__deprecated__v1_accounting_purchase_invoice__id__documents_get","metadata":{"seo":{"title":"Retrieve Purchase Invoice Documents (Deprecated)","description":"(deprecated, use /purchase-invoice/{id}/documents instead)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Retrieve_purchase_invoice_documents__deprecated__v1_accounting_purchase_invoice__id__documents_get","name":"Retrieve Purchase Invoice Documents (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1accounting~1purchase_invoice~1{id}~1documents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Purchase Invoice Documents (Deprecated)","isWebhook":false,"deprecated":true,"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":"(deprecated, use /purchase-invoice/{id}/documents instead)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1purchase_invoice~1{id}~1documents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/purchase_invoice/{id}/documents","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/purchase_invoice/{id}/documents","href":"use-case-accounting/retrieve_purchase_invoice_documents__deprecated__v1_accounting_purchase_invoice__id__documents_get","openApiOperationId":"Retrieve_purchase_invoice_documents__deprecated__v1_accounting_purchase_invoice__id__documents_get","summary":"Retrieve Purchase Invoice Documents (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_111"}},"schemaId":"schema_111"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1purchase_invoice~1{id}~1documents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_111","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_111"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-accounting/retrieve_purchase_invoice_documents__deprecated__v1_accounting_purchase_invoice__id__documents_get"}],"panels":[]}]},"httpPath":"/v1/accounting/purchase_invoice/{id}/documents"},{"label":"Report Payment Status For Purchase Invoice (Deprecated)","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-accounting/report_payment_status_for_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__payment_update_status_post","routeSlug":"/docs/use-case-accounting/report_payment_status_for_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__payment_update_status_post","metadata":{"seo":{"title":"Report Payment Status For Purchase Invoice (Deprecated)","description":"(deprecated, use /purchase-invoice/{id}/payment/update-status instead)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Report_payment_status_for_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__payment_update_status_post","name":"Report Payment Status For Purchase Invoice (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1accounting~1purchase_invoice~1{id}~1payment~1update-status/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Report Payment Status For Purchase Invoice (Deprecated)","isWebhook":false,"deprecated":true,"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":"(deprecated, use /purchase-invoice/{id}/payment/update-status instead)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1purchase_invoice~1{id}~1payment~1update-status/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}},"schemaId":"components/schemas/PaymentStatusUpdate","pointer":"/paths/~1v1~1accounting~1purchase_invoice~1{id}~1payment~1update-status/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/accounting/purchase_invoice/{id}/payment/update-status","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/purchase_invoice/{id}/payment/update-status","href":"use-case-accounting/report_payment_status_for_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__payment_update_status_post","openApiOperationId":"Report_payment_status_for_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__payment_update_status_post","summary":"Report Payment Status For Purchase Invoice (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/PaymentStatusUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}},"schemaId":"components/schemas/PaymentStatusUpdate"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1purchase_invoice~1{id}~1payment~1update-status/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentStatusUpdate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-accounting/report_payment_status_for_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__payment_update_status_post"}],"panels":[]}]},"httpPath":"/v1/accounting/purchase_invoice/{id}/payment/update-status"},{"label":"Retrieve Sales Credit Note (Deprecated)","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-accounting/retrieve_sales_credit_note__deprecated__v1_accounting_sales_credit_note__id__get","routeSlug":"/docs/use-case-accounting/retrieve_sales_credit_note__deprecated__v1_accounting_sales_credit_note__id__get","metadata":{"seo":{"title":"Retrieve Sales Credit Note (Deprecated)","description":"(deprecated, use /sales-credit-note/{id} instead)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Retrieve_sales_credit_note__deprecated__v1_accounting_sales_credit_note__id__get","name":"Retrieve Sales Credit Note (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sales_credit_note~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Sales Credit Note (Deprecated)","isWebhook":false,"deprecated":true,"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":"(deprecated, use /sales-credit-note/{id} instead)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1sales_credit_note~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/sales_credit_note/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sales_credit_note/{id}","href":"use-case-accounting/retrieve_sales_credit_note__deprecated__v1_accounting_sales_credit_note__id__get","openApiOperationId":"Retrieve_sales_credit_note__deprecated__v1_accounting_sales_credit_note__id__get","summary":"Retrieve Sales Credit Note (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SalesCreditNoteOutput"}},"schemaId":"components/schemas/SalesCreditNoteOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sales_credit_note~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SalesCreditNoteOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SalesCreditNoteOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-accounting/retrieve_sales_credit_note__deprecated__v1_accounting_sales_credit_note__id__get"}],"panels":[]}]},"httpPath":"/v1/accounting/sales_credit_note/{id}"},{"label":"Update Credit Note (Deprecated)","deprecated":true,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-accounting/update_credit_note__deprecated__v1_accounting_sales_credit_note__id__patch","routeSlug":"/docs/use-case-accounting/update_credit_note__deprecated__v1_accounting_sales_credit_note__id__patch","metadata":{"seo":{"title":"Update Credit Note (Deprecated)","description":"(deprecated, use /sales-credit-note/{id} instead)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update_credit_note__deprecated__v1_accounting_sales_credit_note__id__patch","name":"Update Credit Note (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sales_credit_note~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Credit Note (Deprecated)","isWebhook":false,"deprecated":true,"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":"(deprecated, use /sales-credit-note/{id} instead)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1sales_credit_note~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SalesCreditNotePatchInput"}},"schemaId":"components/schemas/SalesCreditNotePatchInput","pointer":"/paths/~1v1~1accounting~1sales_credit_note~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/accounting/sales_credit_note/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SalesCreditNotePatchInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sales_credit_note/{id}","href":"use-case-accounting/update_credit_note__deprecated__v1_accounting_sales_credit_note__id__patch","openApiOperationId":"Update_credit_note__deprecated__v1_accounting_sales_credit_note__id__patch","summary":"Update Credit Note (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/SalesCreditNotePatchInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SalesCreditNotePatchInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SalesCreditNoteOutput"}},"schemaId":"components/schemas/SalesCreditNoteOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sales_credit_note~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SalesCreditNoteOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SalesCreditNoteOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-accounting/update_credit_note__deprecated__v1_accounting_sales_credit_note__id__patch"}],"panels":[]}]},"httpPath":"/v1/accounting/sales_credit_note/{id}"},{"label":"Retrieve Sales Credit Note Documents (Deprecated)","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-accounting/retrieve_sales_credit_note_documents__deprecated__v1_accounting_sales_credit_note__id__documents_get","routeSlug":"/docs/use-case-accounting/retrieve_sales_credit_note_documents__deprecated__v1_accounting_sales_credit_note__id__documents_get","metadata":{"seo":{"title":"Retrieve Sales Credit Note Documents (Deprecated)","description":"(deprecated, use /sales-credit-note/{id}/documents instead)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Retrieve_sales_credit_note_documents__deprecated__v1_accounting_sales_credit_note__id__documents_get","name":"Retrieve Sales Credit Note Documents (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sales_credit_note~1{id}~1documents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Sales Credit Note Documents (Deprecated)","isWebhook":false,"deprecated":true,"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":"(deprecated, use /sales-credit-note/{id}/documents instead)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1sales_credit_note~1{id}~1documents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/sales_credit_note/{id}/documents","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sales_credit_note/{id}/documents","href":"use-case-accounting/retrieve_sales_credit_note_documents__deprecated__v1_accounting_sales_credit_note__id__documents_get","openApiOperationId":"Retrieve_sales_credit_note_documents__deprecated__v1_accounting_sales_credit_note__id__documents_get","summary":"Retrieve Sales Credit Note Documents (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_112"}},"schemaId":"schema_112"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sales_credit_note~1{id}~1documents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_112","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_112"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-accounting/retrieve_sales_credit_note_documents__deprecated__v1_accounting_sales_credit_note__id__documents_get"}],"panels":[]}]},"httpPath":"/v1/accounting/sales_credit_note/{id}/documents"},{"label":"Report Refund Status For Sales Credit Note (Deprecated)","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-accounting/report_refund_status_for_sales_credit_note__deprecated__v1_accounting_sales_credit_note__id__refund_update_status_post","routeSlug":"/docs/use-case-accounting/report_refund_status_for_sales_credit_note__deprecated__v1_accounting_sales_credit_note__id__refund_update_status_post","metadata":{"seo":{"title":"Report Refund Status For Sales Credit Note (Deprecated)","description":"(deprecated, use /sales-credit-note/{id}/refund/update-status instead)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Report_refund_status_for_sales_credit_note__deprecated__v1_accounting_sales_credit_note__id__refund_update_status_post","name":"Report Refund Status For Sales Credit Note (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sales_credit_note~1{id}~1refund~1update-status/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Report Refund Status For Sales Credit Note (Deprecated)","isWebhook":false,"deprecated":true,"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":"(deprecated, use /sales-credit-note/{id}/refund/update-status instead)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1sales_credit_note~1{id}~1refund~1update-status/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RefundStatusUpdate"}},"schemaId":"components/schemas/RefundStatusUpdate","pointer":"/paths/~1v1~1accounting~1sales_credit_note~1{id}~1refund~1update-status/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/accounting/sales_credit_note/{id}/refund/update-status","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RefundStatusUpdate"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sales_credit_note/{id}/refund/update-status","href":"use-case-accounting/report_refund_status_for_sales_credit_note__deprecated__v1_accounting_sales_credit_note__id__refund_update_status_post","openApiOperationId":"Report_refund_status_for_sales_credit_note__deprecated__v1_accounting_sales_credit_note__id__refund_update_status_post","summary":"Report Refund Status For Sales Credit Note (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/RefundStatusUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RefundStatusUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RefundStatusUpdate"}},"schemaId":"components/schemas/RefundStatusUpdate"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sales_credit_note~1{id}~1refund~1update-status/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RefundStatusUpdate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RefundStatusUpdate"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-accounting/report_refund_status_for_sales_credit_note__deprecated__v1_accounting_sales_credit_note__id__refund_update_status_post"}],"panels":[]}]},"httpPath":"/v1/accounting/sales_credit_note/{id}/refund/update-status"},{"label":"Retrieve Sales Invoice (Deprecated)","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-accounting/retrieve_sales_invoice__deprecated__v1_accounting_sales_invoice__id__get","routeSlug":"/docs/use-case-accounting/retrieve_sales_invoice__deprecated__v1_accounting_sales_invoice__id__get","metadata":{"seo":{"title":"Retrieve Sales Invoice (Deprecated)","description":"(deprecated, use /sales-invoice/{id} instead)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Retrieve_sales_invoice__deprecated__v1_accounting_sales_invoice__id__get","name":"Retrieve Sales Invoice (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sales_invoice~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Sales Invoice (Deprecated)","isWebhook":false,"deprecated":true,"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":"(deprecated, use /sales-invoice/{id} instead)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1sales_invoice~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/sales_invoice/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sales_invoice/{id}","href":"use-case-accounting/retrieve_sales_invoice__deprecated__v1_accounting_sales_invoice__id__get","openApiOperationId":"Retrieve_sales_invoice__deprecated__v1_accounting_sales_invoice__id__get","summary":"Retrieve Sales Invoice (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SalesInvoiceOutput"}},"schemaId":"components/schemas/SalesInvoiceOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sales_invoice~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SalesInvoiceOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SalesInvoiceOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-accounting/retrieve_sales_invoice__deprecated__v1_accounting_sales_invoice__id__get"}],"panels":[]}]},"httpPath":"/v1/accounting/sales_invoice/{id}"},{"label":"Update Sales Invoice (Deprecated)","deprecated":true,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-accounting/update_sales_invoice__deprecated__v1_accounting_sales_invoice__id__patch","routeSlug":"/docs/use-case-accounting/update_sales_invoice__deprecated__v1_accounting_sales_invoice__id__patch","metadata":{"seo":{"title":"Update Sales Invoice (Deprecated)","description":"(deprecated, use /sales-invoice/{id} instead)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update_sales_invoice__deprecated__v1_accounting_sales_invoice__id__patch","name":"Update Sales Invoice (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sales_invoice~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Sales Invoice (Deprecated)","isWebhook":false,"deprecated":true,"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":"(deprecated, use /sales-invoice/{id} instead)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1sales_invoice~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SalesInvoicePatchInput"}},"schemaId":"components/schemas/SalesInvoicePatchInput","pointer":"/paths/~1v1~1accounting~1sales_invoice~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/accounting/sales_invoice/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SalesInvoicePatchInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sales_invoice/{id}","href":"use-case-accounting/update_sales_invoice__deprecated__v1_accounting_sales_invoice__id__patch","openApiOperationId":"Update_sales_invoice__deprecated__v1_accounting_sales_invoice__id__patch","summary":"Update Sales Invoice (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/SalesInvoicePatchInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SalesInvoicePatchInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SalesInvoiceOutput"}},"schemaId":"components/schemas/SalesInvoiceOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sales_invoice~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SalesInvoiceOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SalesInvoiceOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-accounting/update_sales_invoice__deprecated__v1_accounting_sales_invoice__id__patch"}],"panels":[]}]},"httpPath":"/v1/accounting/sales_invoice/{id}"},{"label":"Retrieve Sales Invoice Documents (Deprecated)","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-accounting/retrieve_sales_invoice_documents__deprecated__v1_accounting_sales_invoice__id__documents_get","routeSlug":"/docs/use-case-accounting/retrieve_sales_invoice_documents__deprecated__v1_accounting_sales_invoice__id__documents_get","metadata":{"seo":{"title":"Retrieve Sales Invoice Documents (Deprecated)","description":"(deprecated, use /sales-invoice/{id}/documents instead)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Retrieve_sales_invoice_documents__deprecated__v1_accounting_sales_invoice__id__documents_get","name":"Retrieve Sales Invoice Documents (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sales_invoice~1{id}~1documents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Sales Invoice Documents (Deprecated)","isWebhook":false,"deprecated":true,"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":"(deprecated, use /sales-invoice/{id}/documents instead)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1sales_invoice~1{id}~1documents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/sales_invoice/{id}/documents","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sales_invoice/{id}/documents","href":"use-case-accounting/retrieve_sales_invoice_documents__deprecated__v1_accounting_sales_invoice__id__documents_get","openApiOperationId":"Retrieve_sales_invoice_documents__deprecated__v1_accounting_sales_invoice__id__documents_get","summary":"Retrieve Sales Invoice Documents (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_113"}},"schemaId":"schema_113"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sales_invoice~1{id}~1documents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_113","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_113"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-accounting/retrieve_sales_invoice_documents__deprecated__v1_accounting_sales_invoice__id__documents_get"}],"panels":[]}]},"httpPath":"/v1/accounting/sales_invoice/{id}/documents"},{"label":"Report Payment Status For Sales Invoice (Deprecated)","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-accounting/report_payment_status_for_sales_invoice__deprecated__v1_accounting_sales_invoice__id__payment_update_status_post","routeSlug":"/docs/use-case-accounting/report_payment_status_for_sales_invoice__deprecated__v1_accounting_sales_invoice__id__payment_update_status_post","metadata":{"seo":{"title":"Report Payment Status For Sales Invoice (Deprecated)","description":"(deprecated, use /sales-invoice/{id}/payment/update-status instead)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Report_payment_status_for_sales_invoice__deprecated__v1_accounting_sales_invoice__id__payment_update_status_post","name":"Report Payment Status For Sales Invoice (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sales_invoice~1{id}~1payment~1update-status/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Report Payment Status For Sales Invoice (Deprecated)","isWebhook":false,"deprecated":true,"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":"(deprecated, use /sales-invoice/{id}/payment/update-status instead)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1sales_invoice~1{id}~1payment~1update-status/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}},"schemaId":"components/schemas/PaymentStatusUpdate","pointer":"/paths/~1v1~1accounting~1sales_invoice~1{id}~1payment~1update-status/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/accounting/sales_invoice/{id}/payment/update-status","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sales_invoice/{id}/payment/update-status","href":"use-case-accounting/report_payment_status_for_sales_invoice__deprecated__v1_accounting_sales_invoice__id__payment_update_status_post","openApiOperationId":"Report_payment_status_for_sales_invoice__deprecated__v1_accounting_sales_invoice__id__payment_update_status_post","summary":"Report Payment Status For Sales Invoice (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/PaymentStatusUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}},"schemaId":"components/schemas/PaymentStatusUpdate"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sales_invoice~1{id}~1payment~1update-status/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentStatusUpdate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-accounting/report_payment_status_for_sales_invoice__deprecated__v1_accounting_sales_invoice__id__payment_update_status_post"}],"panels":[]}]},"httpPath":"/v1/accounting/sales_invoice/{id}/payment/update-status"}],"content":{"contentType":"group","meta":{"name":"Use case / Accounting"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Use case / Accounting","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":"Required role: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"API_ACCOUNTING"},"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":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/section/accounting"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accounting"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/accounting/accounts","summary":"List Accounts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-accounting/list_accounts_v1_accounting_accounts_get","deprecated":false},{"title":"/v1/accounting/accounts/{id}","summary":"Retrieve Account","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-accounting/retrieve_account_v1_accounting_accounts__id__get","deprecated":false},{"title":"/v1/accounting/exchange-rate","summary":"Create An Exchange Rate","prefix":{"name":"post","color":"post"},"badges":[],"link":"/use-case-accounting/create_an_exchange_rate_v1_accounting_exchange_rate_post","deprecated":false},{"title":"/v1/accounting/exchange-rate","summary":"List Exchange Rates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-accounting/list_exchange_rates_v1_accounting_exchange_rate_get","deprecated":false},{"title":"/v1/accounting/purchase-credit-note/{id}","summary":"Retrieve Purchase Credit Note","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-accounting/retrieve_purchase_credit_note_v1_accounting_purchase_credit_note__id__get","deprecated":false},{"title":"/v1/accounting/purchase-credit-note/{id}","summary":"Update Purchase Credit Note","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/use-case-accounting/update_purchase_credit_note_v1_accounting_purchase_credit_note__id__patch","deprecated":false},{"title":"/v1/accounting/purchase-credit-note/{id}/documents","summary":"Retrieve Purchase Credit Note Documents","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-accounting/retrieve_purchase_credit_note_documents_v1_accounting_purchase_credit_note__id__documents_get","deprecated":false},{"title":"/v1/accounting/purchase-credit-note/{id}/refund/update-status","summary":"Report Refund Status For Purchase Credit Note","prefix":{"name":"post","color":"post"},"badges":[],"link":"/use-case-accounting/report_refund_status_for_purchase_credit_note_v1_accounting_purchase_credit_note__id__refund_update_status_post","deprecated":false},{"title":"/v1/accounting/purchase-invoice/{id}","summary":"Retrieve Purchase Invoice","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-accounting/retrieve_purchase_invoice_v1_accounting_purchase_invoice__id__get","deprecated":false},{"title":"/v1/accounting/purchase-invoice/{id}","summary":"Update Purchase Invoice","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/use-case-accounting/update_purchase_invoice_v1_accounting_purchase_invoice__id__patch","deprecated":false},{"title":"/v1/accounting/purchase-invoice/{id}/documents","summary":"Retrieve Purchase Invoice Documents","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-accounting/retrieve_purchase_invoice_documents_v1_accounting_purchase_invoice__id__documents_get","deprecated":false},{"title":"/v1/accounting/purchase-invoice/{id}/payment/update-status","summary":"Report Payment Status For Purchase Invoice","prefix":{"name":"post","color":"post"},"badges":[],"link":"/use-case-accounting/report_payment_status_for_purchase_invoice_v1_accounting_purchase_invoice__id__payment_update_status_post","deprecated":false},{"title":"/v1/accounting/sales-credit-note/","summary":"Create A Sales Credit Note","prefix":{"name":"post","color":"post"},"badges":[],"link":"/use-case-accounting/create_a_sales_credit_note_v1_accounting_sales_credit_note__post","deprecated":false},{"title":"/v1/accounting/sales-credit-note/{id}","summary":"Retrieve Sales Credit Note","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-accounting/retrieve_sales_credit_note_v1_accounting_sales_credit_note__id__get","deprecated":false},{"title":"/v1/accounting/sales-credit-note/{id}","summary":"Update Credit Note","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/use-case-accounting/update_credit_note_v1_accounting_sales_credit_note__id__patch","deprecated":false},{"title":"/v1/accounting/sales-credit-note/{id}/documents","summary":"Retrieve Sales Credit Note Documents","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-accounting/retrieve_sales_credit_note_documents_v1_accounting_sales_credit_note__id__documents_get","deprecated":false},{"title":"/v1/accounting/sales-credit-note/{id}/refund/update-status","summary":"Report Refund Status For Sales Credit Note","prefix":{"name":"post","color":"post"},"badges":[],"link":"/use-case-accounting/report_refund_status_for_sales_credit_note_v1_accounting_sales_credit_note__id__refund_update_status_post","deprecated":false},{"title":"/v1/accounting/sales-invoice/","summary":"Create A Sales Invoice","prefix":{"name":"post","color":"post"},"badges":[],"link":"/use-case-accounting/create_a_sales_invoice_v1_accounting_sales_invoice__post","deprecated":false},{"title":"/v1/accounting/sales-invoice/{id}","summary":"Retrieve Sales Invoice","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-accounting/retrieve_sales_invoice_v1_accounting_sales_invoice__id__get","deprecated":false},{"title":"/v1/accounting/sales-invoice/{id}","summary":"Update Sales Invoice","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/use-case-accounting/update_sales_invoice_v1_accounting_sales_invoice__id__patch","deprecated":false},{"title":"/v1/accounting/sales-invoice/{id}/documents","summary":"Retrieve Sales Invoice Documents","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-accounting/retrieve_sales_invoice_documents_v1_accounting_sales_invoice__id__documents_get","deprecated":false},{"title":"/v1/accounting/sales-invoice/{id}/payment/update-status","summary":"Report Payment Status For Sales Invoice","prefix":{"name":"post","color":"post"},"badges":[],"link":"/use-case-accounting/report_payment_status_for_sales_invoice_v1_accounting_sales_invoice__id__payment_update_status_post","deprecated":false},{"title":"/v1/accounting/sync-tasks","summary":"List Invoices/Credit Notes To Sync","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-accounting/list_invoices_credit_notes_to_sync_v1_accounting_sync_tasks_get","deprecated":false},{"title":"/v1/accounting/sync-tasks/{id}","summary":"Get Details Of Invoice/Credit Note To Sync","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-accounting/get_details_of_invoice_credit_note_to_sync_v1_accounting_sync_tasks__id__get","deprecated":false},{"title":"/v1/accounting/sync-tasks/{id}/update-status","summary":"Report Sync Status For Invoice/Credit Note","prefix":{"name":"post","color":"post"},"badges":[],"link":"/use-case-accounting/report_sync_status_for_invoice_credit_note_v1_accounting_sync_tasks__id__update_status_post","deprecated":false},{"title":"/v1/accounting/tax-rates","summary":"List Tax Rates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-accounting/list_tax_rates_v1_accounting_tax_rates_get","deprecated":false},{"title":"/v1/accounting/tax-rates/{id}","summary":"Retrieve Tax Rate","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-accounting/retrieve_tax_rate_v1_accounting_tax_rates__id__get","deprecated":false},{"title":"/v1/documents/document/{id}/download","summary":"Download Document","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-accounting/download_document_v1_documents_document__id__download_get","deprecated":false},{"title":"/v1/webhook/billing-document-update","summary":"External Billing Document (Invoice/Credit-Note) Update","prefix":{"name":"post","color":"post"},"badges":[],"link":"/use-case-accounting/billing-document-update-webhook","deprecated":false},{"title":"https://<accounting-visibility-event-receiving-payload>","summary":"Accounting Visibility Event","prefix":{"name":"post","color":"post"},"badges":[],"link":"/use-case-accounting/accounting_visibility_eventhttps____accounting_visibility_event_receiving_payload__post","deprecated":false},{"title":"/v1/accounting/company","summary":"List Companies (Deprecated)","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/use-case-accounting/list_companies__deprecated__v1_accounting_company_get","deprecated":true},{"title":"/v1/accounting/company","summary":"Create Company (Deprecated)","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/use-case-accounting/create_company__deprecated__v1_accounting_company_post","deprecated":true},{"title":"/v1/accounting/company/{id}","summary":"Get Company (Deprecated)","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/use-case-accounting/get_company__deprecated__v1_accounting_company__id__get","deprecated":true},{"title":"/v1/accounting/company/{id}","summary":"Update Company (Deprecated)","prefix":{"name":"put","color":"http-deprecated"},"badges":[],"link":"/use-case-accounting/update_company__deprecated__v1_accounting_company__id__put","deprecated":true},{"title":"/v1/accounting/company/{id}","summary":"Update Company (Deprecated)","prefix":{"name":"patch","color":"http-deprecated"},"badges":[],"link":"/use-case-accounting/update_company__deprecated__v1_accounting_company__id__patch","deprecated":true},{"title":"/v1/accounting/company/{id}","summary":"Archive Company (Deprecated)","prefix":{"name":"delete","color":"http-deprecated"},"badges":[],"link":"/use-case-accounting/archive_company__deprecated__v1_accounting_company__id__delete","deprecated":true},{"title":"/v1/accounting/purchase_invoice/{id}","summary":"Retrieve Purchase Invoice (Deprecated)","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/use-case-accounting/retrieve_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__get","deprecated":true},{"title":"/v1/accounting/purchase_invoice/{id}","summary":"Update Purchase Invoice (Deprecated)","prefix":{"name":"patch","color":"http-deprecated"},"badges":[],"link":"/use-case-accounting/update_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__patch","deprecated":true},{"title":"/v1/accounting/purchase_invoice/{id}/documents","summary":"Retrieve Purchase Invoice Documents (Deprecated)","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/use-case-accounting/retrieve_purchase_invoice_documents__deprecated__v1_accounting_purchase_invoice__id__documents_get","deprecated":true},{"title":"/v1/accounting/purchase_invoice/{id}/payment/update-status","summary":"Report Payment Status For Purchase Invoice (Deprecated)","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/use-case-accounting/report_payment_status_for_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__payment_update_status_post","deprecated":true},{"title":"/v1/accounting/sales_credit_note/{id}","summary":"Retrieve Sales Credit Note (Deprecated)","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/use-case-accounting/retrieve_sales_credit_note__deprecated__v1_accounting_sales_credit_note__id__get","deprecated":true},{"title":"/v1/accounting/sales_credit_note/{id}","summary":"Update Credit Note (Deprecated)","prefix":{"name":"patch","color":"http-deprecated"},"badges":[],"link":"/use-case-accounting/update_credit_note__deprecated__v1_accounting_sales_credit_note__id__patch","deprecated":true},{"title":"/v1/accounting/sales_credit_note/{id}/documents","summary":"Retrieve Sales Credit Note Documents (Deprecated)","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/use-case-accounting/retrieve_sales_credit_note_documents__deprecated__v1_accounting_sales_credit_note__id__documents_get","deprecated":true},{"title":"/v1/accounting/sales_credit_note/{id}/refund/update-status","summary":"Report Refund Status For Sales Credit Note (Deprecated)","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/use-case-accounting/report_refund_status_for_sales_credit_note__deprecated__v1_accounting_sales_credit_note__id__refund_update_status_post","deprecated":true},{"title":"/v1/accounting/sales_invoice/{id}","summary":"Retrieve Sales Invoice (Deprecated)","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/use-case-accounting/retrieve_sales_invoice__deprecated__v1_accounting_sales_invoice__id__get","deprecated":true},{"title":"/v1/accounting/sales_invoice/{id}","summary":"Update Sales Invoice (Deprecated)","prefix":{"name":"patch","color":"http-deprecated"},"badges":[],"link":"/use-case-accounting/update_sales_invoice__deprecated__v1_accounting_sales_invoice__id__patch","deprecated":true},{"title":"/v1/accounting/sales_invoice/{id}/documents","summary":"Retrieve Sales Invoice Documents (Deprecated)","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/use-case-accounting/retrieve_sales_invoice_documents__deprecated__v1_accounting_sales_invoice__id__documents_get","deprecated":true},{"title":"/v1/accounting/sales_invoice/{id}/payment/update-status","summary":"Report Payment Status For Sales Invoice (Deprecated)","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/use-case-accounting/report_payment_status_for_sales_invoice__deprecated__v1_accounting_sales_invoice__id__payment_update_status_post","deprecated":true}]}]}]}]}},{"type":"group","label":"Use case / Customer portal","link":"/docs/use-case-customer-portal","routeSlug":"/docs/use-case-customer-portal","items":[{"type":"link","label":"Getting started","link":"/docs/use-case-customer-portal/getting-started","routeSlug":"/docs/use-case-customer-portal/getting-started","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Getting started"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"use-case-customer-portal/getting-started"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Getting started"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/section/transport-order-creation-and-status"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get started."},"children":[]}]}]}]}],"panels":[]}]}},{"label":"Download Document","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-customer-portal/download_document_v1_documents_document__id__download_get","routeSlug":"/docs/use-case-customer-portal/download_document_v1_documents_document__id__download_get","metadata":{"seo":{"title":"Download Document","description":"Download a document by its ID. You can choose to download the document directly or stream it."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"download_document_v1_documents_document__id__download_get","name":"Download Document","isWebhook":false,"pointer":"/paths/~1v1~1documents~1document~1{id}~1download/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download Document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Download a document by its ID. You can choose to download the document directly or stream it."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1documents~1document~1{id}~1download/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"direct","in":"query","schemaId":"schema_105","description":"Query parameter to indicate that the response should contain all the document bytes"}],"pointer":"/paths/~1v1~1documents~1document~1{id}~1download/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/documents/document/{id}/download","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[{"name":"direct","in":"query","required":false,"schemaId":"schema_105"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/documents/document/{id}/download","href":"use-case-customer-portal/download_document_v1_documents_document__id__download_get","openApiOperationId":"download_document_v1_documents_document__id__download_get","summary":"Download Document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}},"schemaId":"schema_106"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1documents~1document~1{id}~1download/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_106","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-customer-portal/download_document_v1_documents_document__id__download_get"}],"panels":[]}]},"httpPath":"/v1/documents/document/{id}/download"},{"label":"Import Order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-customer-portal/import_order_v1_orders_order_upload_post","routeSlug":"/docs/use-case-customer-portal/import_order_v1_orders_order_upload_post","metadata":{"seo":{"title":"Import Order","description":"Create or update orders in Qargo. See the \"Transport order creation & status\" section for more info."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"import_order_v1_orders_order_upload_post","name":"Import Order","isWebhook":false,"pointer":"/paths/~1v1~1orders~1order~1upload/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Import Order","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":"Create or update orders in Qargo. See the \"Transport order creation & status\" section for more info."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderInput"}},"schemaId":"components/schemas/OrderInput","pointer":"/paths/~1v1~1orders~1order~1upload/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/orders/order/upload","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrderInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/orders/order/upload","href":"use-case-customer-portal/import_order_v1_orders_order_upload_post","openApiOperationId":"import_order_v1_orders_order_upload_post","summary":"Import Order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/OrderInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderImport"}},"schemaId":"components/schemas/OrderImport"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1orders~1order~1upload/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderImport","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderImport"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-customer-portal/import_order_v1_orders_order_upload_post"}],"panels":[]}]},"httpPath":"/v1/orders/order/upload"},{"label":"Get Order Import Status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-customer-portal/get_order_import_status_v1_orders_order_upload__upload_id__get","routeSlug":"/docs/use-case-customer-portal/get_order_import_status_v1_orders_order_upload__upload_id__get","metadata":{"seo":{"title":"Get Order Import Status","description":"Get the status of an order import"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_order_import_status_v1_orders_order_upload__upload_id__get","name":"Get Order Import Status","isWebhook":false,"pointer":"/paths/~1v1~1orders~1order~1upload~1{upload_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Order Import Status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the status of an order import"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"upload_id","in":"path","schemaId":"schema_114","required":true}],"pointer":"/paths/~1v1~1orders~1order~1upload~1{upload_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/orders/order/upload/{upload_id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"upload_id","in":"path","required":true,"schemaId":"schema_114"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/orders/order/upload/{upload_id}","href":"use-case-customer-portal/get_order_import_status_v1_orders_order_upload__upload_id__get","openApiOperationId":"get_order_import_status_v1_orders_order_upload__upload_id__get","summary":"Get Order Import Status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderImport"}},"schemaId":"components/schemas/OrderImport"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1orders~1order~1upload~1{upload_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderImport","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderImport"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-customer-portal/get_order_import_status_v1_orders_order_upload__upload_id__get"}],"panels":[]}]},"httpPath":"/v1/orders/order/upload/{upload_id}"},{"label":"Get Order Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-customer-portal/get_order_details_v1_orders_order__order_id__get","routeSlug":"/docs/use-case-customer-portal/get_order_details_v1_orders_order__order_id__get","metadata":{"seo":{"title":"Get Order Details","description":"Fetch order detail"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_order_details_v1_orders_order__order_id__get","name":"Get Order Details","isWebhook":false,"pointer":"/paths/~1v1~1orders~1order~1{order_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Order Details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetch order detail"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"order_id","in":"path","schemaId":"schema_115","required":true}],"pointer":"/paths/~1v1~1orders~1order~1{order_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/orders/order/{order_id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"order_id","in":"path","required":true,"schemaId":"schema_115"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/orders/order/{order_id}","href":"use-case-customer-portal/get_order_details_v1_orders_order__order_id__get","openApiOperationId":"get_order_details_v1_orders_order__order_id__get","summary":"Get Order Details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderDetailOutput"}},"schemaId":"components/schemas/OrderDetailOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1orders~1order~1{order_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderDetailOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderDetailOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-customer-portal/get_order_details_v1_orders_order__order_id__get"}],"panels":[]}]},"httpPath":"/v1/orders/order/{order_id}"},{"label":"List Order Charges","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-customer-portal/list_order_charges_v1_orders_order__order_id__charges_get","routeSlug":"/docs/use-case-customer-portal/list_order_charges_v1_orders_order__order_id__charges_get","metadata":{"seo":{"title":"List Order Charges","description":"Charges for a certain order. Note that these charges are not final and may change"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"List_Order_Charges_v1_orders_order__order_id__charges_get","name":"List Order Charges","isWebhook":false,"pointer":"/paths/~1v1~1orders~1order~1{order_id}~1charges/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Order Charges","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Charges for a certain order. Note that these charges are not final and may change"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"order_id","in":"path","schemaId":"schema_115","required":true}],"pointer":"/paths/~1v1~1orders~1order~1{order_id}~1charges/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/orders/order/{order_id}/charges","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"order_id","in":"path","required":true,"schemaId":"schema_115"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/orders/order/{order_id}/charges","href":"use-case-customer-portal/list_order_charges_v1_orders_order__order_id__charges_get","openApiOperationId":"List_Order_Charges_v1_orders_order__order_id__charges_get","summary":"List Order Charges"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderChargesOutput"}},"schemaId":"components/schemas/OrderChargesOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1orders~1order~1{order_id}~1charges/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderChargesOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderChargesOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-customer-portal/list_order_charges_v1_orders_order__order_id__charges_get"}],"panels":[]}]},"httpPath":"/v1/orders/order/{order_id}/charges"},{"label":"Approve Order Charges","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-customer-portal/approve_order_charges_v1_orders_order__order_id__charges_approval_post","routeSlug":"/docs/use-case-customer-portal/approve_order_charges_v1_orders_order__order_id__charges_approval_post","metadata":{"seo":{"title":"Approve Order Charges","description":"Approve or reject certain charges on the order"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Approve_Order_Charges_v1_orders_order__order_id__charges_approval_post","name":"Approve Order Charges","isWebhook":false,"pointer":"/paths/~1v1~1orders~1order~1{order_id}~1charges~1approval/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Approve Order Charges","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Approve or reject certain charges on the order"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"order_id","in":"path","schemaId":"schema_115","required":true}],"pointer":"/paths/~1v1~1orders~1order~1{order_id}~1charges~1approval/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ChargesApprovalInput"}},"schemaId":"components/schemas/ChargesApprovalInput","pointer":"/paths/~1v1~1orders~1order~1{order_id}~1charges~1approval/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/orders/order/{order_id}/charges/approval","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"order_id","in":"path","required":true,"schemaId":"schema_115"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ChargesApprovalInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/orders/order/{order_id}/charges/approval","href":"use-case-customer-portal/approve_order_charges_v1_orders_order__order_id__charges_approval_post","openApiOperationId":"Approve_Order_Charges_v1_orders_order__order_id__charges_approval_post","summary":"Approve Order Charges"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/ChargesApprovalInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ChargesApprovalInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderChargesOutput"}},"schemaId":"components/schemas/OrderChargesOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1orders~1order~1{order_id}~1charges~1approval/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderChargesOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderChargesOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-customer-portal/approve_order_charges_v1_orders_order__order_id__charges_approval_post"}],"panels":[]}]},"httpPath":"/v1/orders/order/{order_id}/charges/approval"},{"label":"List Order Documents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-customer-portal/list_order_documents_v1_orders_order__order_id__documents_get","routeSlug":"/docs/use-case-customer-portal/list_order_documents_v1_orders_order__order_id__documents_get","metadata":{"seo":{"title":"List Order Documents","description":"Fetch documents for an order. This includes consignment documents"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_order_documents_v1_orders_order__order_id__documents_get","name":"List Order Documents","isWebhook":false,"pointer":"/paths/~1v1~1orders~1order~1{order_id}~1documents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Order Documents","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":"Fetch documents for an order. This includes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consignment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" documents"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"order_id","in":"path","schemaId":"schema_115","required":true}],"pointer":"/paths/~1v1~1orders~1order~1{order_id}~1documents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/orders/order/{order_id}/documents","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"order_id","in":"path","required":true,"schemaId":"schema_115"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/orders/order/{order_id}/documents","href":"use-case-customer-portal/list_order_documents_v1_orders_order__order_id__documents_get","openApiOperationId":"list_order_documents_v1_orders_order__order_id__documents_get","summary":"List Order Documents"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_116"}},"schemaId":"schema_116"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1orders~1order~1{order_id}~1documents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_116","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_116"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-customer-portal/list_order_documents_v1_orders_order__order_id__documents_get"}],"panels":[]}]},"httpPath":"/v1/orders/order/{order_id}/documents"},{"label":"Order Export","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-customer-portal/order_export_v1_orders_order__order_id__export_get","routeSlug":"/docs/use-case-customer-portal/order_export_v1_orders_order__order_id__export_get","metadata":{"seo":{"title":"Order Export","description":"Provides a minimal set of order data that can be used as a blueprint to create a new order"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"order_export_v1_orders_order__order_id__export_get","name":"Order Export","isWebhook":false,"pointer":"/paths/~1v1~1orders~1order~1{order_id}~1export/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order Export","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Provides a minimal set of order data that can be used as a blueprint to create a new order"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"order_id","in":"path","schemaId":"schema_115","required":true}],"pointer":"/paths/~1v1~1orders~1order~1{order_id}~1export/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/orders/order/{order_id}/export","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"order_id","in":"path","required":true,"schemaId":"schema_115"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/orders/order/{order_id}/export","href":"use-case-customer-portal/order_export_v1_orders_order__order_id__export_get","openApiOperationId":"order_export_v1_orders_order__order_id__export_get","summary":"Order Export"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderExport"}},"schemaId":"components/schemas/OrderExport"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1orders~1order~1{order_id}~1export/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderExport","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderExport"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-customer-portal/order_export_v1_orders_order__order_id__export_get"}],"panels":[]}]},"httpPath":"/v1/orders/order/{order_id}/export"},{"label":"Order Status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-customer-portal/order_status_v1_orders_order__order_id__status_get","routeSlug":"/docs/use-case-customer-portal/order_status_v1_orders_order__order_id__status_get","metadata":{"seo":{"title":"Order Status","description":"Order status endpoint. Provides information on the status of the order"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"order_status_v1_orders_order__order_id__status_get","name":"Order Status","isWebhook":false,"pointer":"/paths/~1v1~1orders~1order~1{order_id}~1status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order Status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Order status endpoint. Provides information on the status of the order"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"order_id","in":"path","schemaId":"schema_115","required":true}],"pointer":"/paths/~1v1~1orders~1order~1{order_id}~1status/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/orders/order/{order_id}/status","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"order_id","in":"path","required":true,"schemaId":"schema_115"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/orders/order/{order_id}/status","href":"use-case-customer-portal/order_status_v1_orders_order__order_id__status_get","openApiOperationId":"order_status_v1_orders_order__order_id__status_get","summary":"Order Status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderWithStatus"}},"schemaId":"components/schemas/OrderWithStatus"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1orders~1order~1{order_id}~1status/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderWithStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderWithStatus"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-customer-portal/order_status_v1_orders_order__order_id__status_get"}],"panels":[]}]},"httpPath":"/v1/orders/order/{order_id}/status"},{"label":"Operational Visibility Event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-customer-portal/operational_visibility_event_webhook_post","routeSlug":"/docs/use-case-customer-portal/operational_visibility_event_webhook_post","metadata":{"seo":{"title":"Operational Visibility Event","description":"Webhook for updates to orders and trips. Subscribe to this endpoint to receive updates."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"operational_visibility_event_webhook_post","name":"Operational Visibility Event","isWebhook":false,"pointer":"/paths/https:~1~1<visibility-event-receiving-endpoint>/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Operational Visibility Event","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":"Webhook for updates to orders and trips. Subscribe to this endpoint to receive updates."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, Qargo sends payloads using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OperationalVisibilityUpdate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" schema:"},"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":"code","inline":true,"attributes":{"content":"order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OrderUpdate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"StopUpdate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DocumentUpdate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EtaUpdate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HandlingUnitUpdate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" events."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OrderImportUpdate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and other events not listed above may not include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not populated"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"by default; including it requires a custom webhook format configured by Qargo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom webhook format configured by Qargo may use a different structure."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_117"}},"schemaId":"schema_117","pointer":"/paths/https:~1~1<visibility-event-receiving-endpoint>/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"https://<visibility-event-receiving-endpoint>","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_117"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"https://<visibility-event-receiving-endpoint>","href":"use-case-customer-portal/operational_visibility_event_webhook_post","openApiOperationId":"operational_visibility_event_webhook_post","summary":"Operational Visibility Event"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"schema_117","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_117"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}},"schemaId":"schema_106"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/https:~1~1<visibility-event-receiving-endpoint>/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_106","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-customer-portal/operational_visibility_event_webhook_post"}],"panels":[]}]},"httpPath":"https://<visibility-event-receiving-endpoint>"}],"content":{"contentType":"group","meta":{"name":"Use case / Customer portal"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Use case / Customer portal","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":"Required api role: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CUSTOMER"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the api equivalent of our customer portal functionality."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customers can use this api to create/update/cancel orders, view charges and receive status updates."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/documents/document/{id}/download","summary":"Download Document","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-customer-portal/download_document_v1_documents_document__id__download_get","deprecated":false},{"title":"/v1/orders/order/upload","summary":"Import Order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/use-case-customer-portal/import_order_v1_orders_order_upload_post","deprecated":false},{"title":"/v1/orders/order/upload/{upload_id}","summary":"Get Order Import Status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-customer-portal/get_order_import_status_v1_orders_order_upload__upload_id__get","deprecated":false},{"title":"/v1/orders/order/{order_id}","summary":"Get Order Details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-customer-portal/get_order_details_v1_orders_order__order_id__get","deprecated":false},{"title":"/v1/orders/order/{order_id}/charges","summary":"List Order Charges","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-customer-portal/list_order_charges_v1_orders_order__order_id__charges_get","deprecated":false},{"title":"/v1/orders/order/{order_id}/charges/approval","summary":"Approve Order Charges","prefix":{"name":"post","color":"post"},"badges":[],"link":"/use-case-customer-portal/approve_order_charges_v1_orders_order__order_id__charges_approval_post","deprecated":false},{"title":"/v1/orders/order/{order_id}/documents","summary":"List Order Documents","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-customer-portal/list_order_documents_v1_orders_order__order_id__documents_get","deprecated":false},{"title":"/v1/orders/order/{order_id}/export","summary":"Order Export","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-customer-portal/order_export_v1_orders_order__order_id__export_get","deprecated":false},{"title":"/v1/orders/order/{order_id}/status","summary":"Order Status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-customer-portal/order_status_v1_orders_order__order_id__status_get","deprecated":false},{"title":"https://<visibility-event-receiving-endpoint>","summary":"Operational Visibility Event","prefix":{"name":"post","color":"post"},"badges":[],"link":"/use-case-customer-portal/operational_visibility_event_webhook_post","deprecated":false}]}]}]}]}},{"type":"group","label":"Use case / Document import","link":"/docs/use-case-document-import","routeSlug":"/docs/use-case-document-import","items":[{"type":"link","label":"Document import methods","link":"/docs/use-case-document-import/document-import-methods","routeSlug":"/docs/use-case-document-import/document-import-methods","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Document import methods"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"use-case-document-import/document-import-methods"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document import methods"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are five ways to get documents into Qargo, grouped by domain:"},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Operational","link":"/docs/use-case-document-import/operational","routeSlug":"/docs/use-case-document-import/operational","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Operational"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"use-case-document-import/operational"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operational"},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"1. Generic document import webhook","link":"/docs/use-case-document-import/1.-generic-document-import-webhook","routeSlug":"/docs/use-case-document-import/1.-generic-document-import-webhook","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"1. Generic document import webhook"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"use-case-document-import/1.-generic-document-import-webhook"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1. Generic document import webhook"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The most flexible option for importing documents at the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order level"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Query parameters are fully configurable per integration and are used to pass file metadata and order matching criteria. Only order-level document types are supported."},"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":"Scope"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Order-level"},"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":"Auth"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Basic Auth (webhook credentials)"},"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":"Query parameters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Configurable per integration ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filename"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is always required)"},"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":"Supported content"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Binary files, text, or base64-encoded content"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-document-import/document-import-webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"generic document import webhook"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for full details."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Master Data","link":"/docs/use-case-document-import/master-data","routeSlug":"/docs/use-case-document-import/master-data","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Master Data"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"use-case-document-import/master-data"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Master Data"},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"2. Synchronous API upload","link":"/docs/use-case-document-import/2.-synchronous-api-upload","routeSlug":"/docs/use-case-document-import/2.-synchronous-api-upload","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"2. Synchronous API upload"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"use-case-document-import/2.-synchronous-api-upload"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2. Synchronous API upload"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload documents directly via the REST API. Used for master data synchronisation (e.g. importing reference documents). Suited for integrations that require a synchronous response."},"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":"Scope"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Master data (sync / import)"},"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":"Auth"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OAuth2 (API credentials)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/api-document/upload_document_content_v1_documents_document_upload_content_post"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"document upload endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for full details."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"3. Subcontractor document upload webhook","link":"/docs/use-case-document-import/3.-subcontractor-document-upload-webhook","routeSlug":"/docs/use-case-document-import/3.-subcontractor-document-upload-webhook","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"3. Subcontractor document upload webhook"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"use-case-document-import/3.-subcontractor-document-upload-webhook"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3. Subcontractor document upload webhook"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload documents linked to a specific "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"stop"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on a subcontracted trip. Uses fixed query parameters for stop identification and document type mapping."},"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":"Scope"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Stop-level (subcontractor trips)"},"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":"Auth"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Basic Auth (webhook credentials)"},"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":"Query parameters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"question_path_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop_id"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-subcontractor-dispatch/subcontractor-document-upload-webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subcontractor document upload webhook"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for full details and example."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"4. Fleet document upload webhook","link":"/docs/use-case-document-import/4.-fleet-document-upload-webhook","routeSlug":"/docs/use-case-document-import/4.-fleet-document-upload-webhook","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"4. Fleet document upload webhook"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"use-case-document-import/4.-fleet-document-upload-webhook"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4. Fleet document upload webhook"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload documents linked to a specific "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"stop"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"stop group"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on a fleet-dispatched trip. Same pattern as the subcontractor variant."},"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":"Scope"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Stop-level (fleet trips)"},"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":"Auth"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Basic Auth (webhook credentials)"},"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":"Query parameters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"question_path_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop_group_id"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-fleet-dispatch/fleet-document-upload-webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fleet document upload webhook"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for full details and example."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Accounting","link":"/docs/use-case-document-import/accounting","routeSlug":"/docs/use-case-document-import/accounting","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Accounting"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"use-case-document-import/accounting"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accounting"},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"5. E-invoicing webhook","link":"/docs/use-case-document-import/5.-e-invoicing-webhook","routeSlug":"/docs/use-case-document-import/5.-e-invoicing-webhook","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"5. E-invoicing webhook"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"use-case-document-import/5.-e-invoicing-webhook"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5. E-invoicing webhook"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Import structured purchase invoices or credit notes, optionally with file attachments (e.g. invoice PDF, CMR). Supports JSON, XML (UBL/Peppol), and multipart uploads."},"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":"Scope"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Purchase invoices / credit notes"},"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":"Auth"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Basic Auth (webhook credentials)"},"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":"Formats"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": JSON, XML (Peppol UBL), multipart/form-data"},"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":"Attachments"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Supported via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array (base64-encoded) in JSON, or as additional parts in multipart uploads"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-e-invoicing/e-invoicing-webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e-invoicing webhook"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for full details, format examples, and attachment handling."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Choosing the right method","link":"/docs/use-case-document-import/choosing-the-right-method","routeSlug":"/docs/use-case-document-import/choosing-the-right-method","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Choosing the right method"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"use-case-document-import/choosing-the-right-method"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Choosing the right method"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Method"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scope"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Auth"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Best for"},"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":"text","inline":true,"attributes":{"content":"Generic document import"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operational"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Basic Auth"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CMR, POD, packing lists — any order-level document"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subcontractor document upload"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operational"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stop"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Basic Auth"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POD/CMR from subcontractor systems (per stop)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fleet document upload"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operational"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stop / Stop group"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Basic Auth"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POD/CMR from fleet apps (per stop or stop group)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Synchronous API upload"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Master Data"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Master data"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reference document synchronisation"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-invoicing"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accounting"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice / Credit note"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Basic Auth"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purchase invoices via Peppol, EDI, or custom format"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"blockquote","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":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The generic document import webhook currently supports "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order-level document types only"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For stop-level documents, use the subcontractor or fleet document upload webhooks."},"children":[]}]}]}]}]}],"panels":[]}]}},{"label":"Upload Document Content","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-document-import/upload_document_content_v1_documents_document_upload_content_post","routeSlug":"/docs/use-case-document-import/upload_document_content_v1_documents_document_upload_content_post","metadata":{"seo":{"title":"Upload Document Content","description":"Upload document content."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Upload_document_content_v1_documents_document_upload_content_post","name":"Upload Document Content","isWebhook":false,"pointer":"/paths/~1v1~1documents~1document~1upload_content/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload Document Content","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Upload document content."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/Body_Upload_document_content_v1_documents_document_upload_content_post"}},"schemaId":"components/schemas/Body_Upload_document_content_v1_documents_document_upload_content_post","pointer":"/paths/~1v1~1documents~1document~1upload_content/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/documents/document/upload_content","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/Body_Upload_document_content_v1_documents_document_upload_content_post"}},"responseCodes":["201","400","401","403","422","429","500","503"],"pointer":"/v1/documents/document/upload_content","href":"use-case-document-import/upload_document_content_v1_documents_document_upload_content_post","openApiOperationId":"Upload_document_content_v1_documents_document_upload_content_post","summary":"Upload Document Content"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/Body_Upload_document_content_v1_documents_document_upload_content_post","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/Body_Upload_document_content_v1_documents_document_upload_content_post"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentUploadResponse"}},"schemaId":"components/schemas/DocumentUploadResponse"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1documents~1document~1upload_content/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/DocumentUploadResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentUploadResponse"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-document-import/upload_document_content_v1_documents_document_upload_content_post"}],"panels":[]}]},"httpPath":"/v1/documents/document/upload_content"},{"label":"Generic Document Import","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-document-import/document-import-webhook","routeSlug":"/docs/use-case-document-import/document-import-webhook","metadata":{"seo":{"title":"Generic Document Import","description":"Webhook for importing documents and attaching them to existing orders in Qargo."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"document-import-webhook","name":"Generic Document Import","isWebhook":false,"pointer":"/paths/~1v1~1webhook~1document-import/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generic Document Import","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":"Webhook for importing documents and attaching them to existing orders in Qargo."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/document-import-webhook/request/use-case-document-import/document-import-webhook/request/how-it-works","deepLinkHash":"/webhooks-inbound/document-import-webhook#webhooks-inbound/document-import-webhook/request/use-case-document-import/document-import-webhook/request/how-it-works"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How it works"},"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":"An external system sends a file to this endpoint with metadata as query parameters."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system matches the document to an order in Qargo using the provided query parameters."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The document is created and attached to the matched order."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/document-import-webhook/request/use-case-document-import/document-import-webhook/request/query-parameters","deepLinkHash":"/webhooks-inbound/document-import-webhook#webhooks-inbound/document-import-webhook/request/use-case-document-import/document-import-webhook/request/query-parameters"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query parameters"},"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":"filename"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is always required. Additional query parameters are "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"configurable"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"per integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" during setup and are used to pass metadata about the file and to match"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the document to an order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query parameters can carry two types of information:"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"webhooks-inbound/document-import-webhook/request/use-case-document-import/document-import-webhook/request/file-metadata","deepLinkHash":"/webhooks-inbound/document-import-webhook#webhooks-inbound/document-import-webhook/request/use-case-document-import/document-import-webhook/request/file-metadata"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File metadata"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information about the document itself, for example:"},"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":"code","inline":true,"attributes":{"content":"filename"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (required) — Name of the uploaded file including extension"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"document_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — The type of document, see the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document types"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section below"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"document_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Display name for the document in Qargo"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"webhooks-inbound/document-import-webhook/request/use-case-document-import/document-import-webhook/request/matching-to-qargo-orders","deepLinkHash":"/webhooks-inbound/document-import-webhook#webhooks-inbound/document-import-webhook/request/use-case-document-import/document-import-webhook/request/matching-to-qargo-orders"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Matching to Qargo orders"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information used to resolve which order the document should be attached to."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following order fields can be matched against:"},"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":"code","inline":true,"attributes":{"content":"customer_reference_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — The customer reference number on the order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — The order name (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OR-12345"},"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":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — The order UUID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The match must resolve to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"exactly one order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If no order or multiple orders match,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the import will be discarded."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The actual set of query parameters and how they map to the above is configured per integration."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/document-import-webhook/request/use-case-document-import/document-import-webhook/request/document-types","deepLinkHash":"/webhooks-inbound/document-import-webhook#webhooks-inbound/document-import-webhook/request/use-case-document-import/document-import-webhook/request/document-types"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document types"},"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":"document_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter must be one of the following values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document type"},"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":"code","inline":true,"attributes":{"content":"ADDRESS_LABEL"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ANALYSIS_CERTIFICATE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ANNEX_VII_WASTE_SHIPMENT"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPROVAL_LOADING_LIST"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ATR"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AUTHORIZATION_PREFERENTIAL_ORIGIN"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BILL_OF_LADING_INSTRUCTIONS"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CATTLE_TRANSPORT_JOURNAL"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CERTIFICATE_OF_ORIGIN"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CERTIFICATE_OF_SHIPMENT"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CLAIM"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CMR_INSURANCE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMMERCIAL_INVOICE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONFIRMATION_TARIFF_SHIPPING_LINE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONSIGNEE_SIGNATURE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONSIGNOR_SIGNATURE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONTAINER_CLEANING_CERTIFICATE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CUSTOMER_PAPERWORK"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CUSTOMS_DECLARATION_INSTRUCTIONS"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CUSTOMS_DOCUMENT"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CUSTOMS_INVOICE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DANGEROUS_GOODS_DECLARATION"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEFENSE_MUNITIONS_VEHICLE_STABLING_REQUEST_FORM"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DISPATCH_CONFIRMATION"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DRAFT_BILL_OF_LADING"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DRIVER_SIGNATURE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DUTCH_CUSTOMS_RELEASE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EQUIPMENT_INTERCHANGE_RECEIPT"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EUR1"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EUR_MED"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXPORT_ACCOMPANYING_DOCUMENT"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXPORT_DECLARATION"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXPORT_DOCUMENT"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXTRA_COST_CONFIRMATION"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXTRA_PERMITTED_WEIGHT"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EX_A_EXPORT_DECLARATION"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINAL_BILL_OF_LADING"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GOODS_IN"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GOODS_OUT"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GPS_TRACKER_REPORT"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IFP"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IMDG"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IMPORT_DECLARATION"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IMPORT_DOCUMENT"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IM_A"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INSURANCE_DOCUMENT"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LOCATION_INFO"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LUMPER_RECEIPT"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MANIFEST"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MULTIMODAL_DANGEROUS_GOODS_DECL"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ORDER_ACCEPTANCE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ORDER_CONFIRMATION"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ORIGINAL_CMR"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OTHER_ADMINISTRATION"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PALLET_LABEL"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PALLET_LABEL_EXTERNAL"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PALLET_NOTE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PHOTO_DAMAGED_GOODS"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PHOTO_OF_GOODS_DELIVERY"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PHOTO_OF_GOODS_PICKUP"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PHOTO_SEAL_NUMBER"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PICKUP_CMR"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PICKUP_NOTE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PREFILLED_CMR"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRICE_OFFER_CUSTOMER"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROOF_OF_DELIVERY"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROOF_OF_DELIVERY_DRIVER_APP"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROOF_OF_DELIVERY_SIGNED"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROOF_OF_PICKUP"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROOF_OF_PICKUP_SIGNED"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUOTE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECEIPT"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAFETY_SECURITY_DECLARATION"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SECURITY_PLAN_FORM"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SINGLE_ADMINISTRATIVE_DOCUMENT"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STANDARD_OPERATING_PROCEDURE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STICKER_LABEL"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"T1_DOCUMENT"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"T2_DOCUMENT"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TEMPERATURE_REPORT"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TIMESLOT_CONFIRMATION"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRANSIT_DOCUMENT"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UK_EXPORTER_DRA"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UK_IMPORTER_DRA"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VGM_CONTAINER"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VISITOR_SAFETY_INSTRUCTION"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WAITING_HOURS_INFORMATION"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WASTE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WAYBILL"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WEIGHING_TICKET"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/document-import-webhook/request/use-case-document-import/document-import-webhook/request/content-encoding","deepLinkHash":"/webhooks-inbound/document-import-webhook#webhooks-inbound/document-import-webhook/request/use-case-document-import/document-import-webhook/request/content-encoding"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content encoding"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content format"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content-Type header"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior"},"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":"text","inline":true,"attributes":{"content":"Binary (e.g. PDF, image)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/png"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", etc."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Passed through as-is"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Text"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/xml"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", etc."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Encoded as UTF-8 bytes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base64-encoded string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Non-text or no header"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base64 decode attempted; raw string used on failure"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header matching the file format."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/document-import-webhook/request/use-case-document-import/document-import-webhook/request/error-handling","deepLinkHash":"/webhooks-inbound/document-import-webhook#webhooks-inbound/document-import-webhook/request/use-case-document-import/document-import-webhook/request/error-handling"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error handling"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scenario"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior"},"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":"text","inline":true,"attributes":{"content":"No order matches the provided criteria"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Import is discarded"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple orders match the criteria"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Import is discarded"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document metadata not provided"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Import is discarded"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuthWebhookCredentials","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filename","in":"query","schemaId":"schema_118","description":"Name of the file being uploaded, including extension. This is used as the primary source for the file name in Qargo.","required":true}],"pointer":"/paths/~1v1~1webhook~1document-import/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_119"}},"schemaId":"schema_119","pointer":"/paths/~1v1~1webhook~1document-import/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/webhook/document-import","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[{"name":"filename","in":"query","required":true,"schemaId":"schema_118"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuthWebhookCredentials","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_119"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/webhook/document-import","href":"use-case-document-import/document-import-webhook","openApiOperationId":"document-import-webhook","summary":"Generic Document Import"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"schema_119","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_119"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentImportResponse"}},"schemaId":"components/schemas/DocumentImportResponse"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1webhook~1document-import/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DocumentImportResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentImportResponse"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-document-import/document-import-webhook"}],"panels":[]}]},"httpPath":"/v1/webhook/document-import"},{"label":"External Document Upload From A Fleet Application","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-document-import/fleet-document-upload-webhook","routeSlug":"/docs/use-case-document-import/fleet-document-upload-webhook","metadata":{"seo":{"title":"External Document Upload From A Fleet Application","description":"Upload a document to a specific stop or stop group on a fleet-dispatched trip."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"fleet-document-upload-webhook","name":"External Document Upload From A Fleet Application","isWebhook":false,"pointer":"/paths/~1v1~1webhook~1fleet-document-upload/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"External Document Upload From A Fleet Application","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":"Upload a document to a specific stop or stop group on a fleet-dispatched trip."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This webhook uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Basic Auth"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (webhook credentials), not the OAuth credentials used for the API."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact integrations@qargo.com to request credentials."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/fleet-document-upload-webhook/request/use-case-fleet-dispatch/fleet-document-upload-webhook/request/use-case-document-import/fleet-document-upload-webhook/request/query-parameters","deepLinkHash":"/webhooks-inbound/fleet-document-upload-webhook#webhooks-inbound/fleet-document-upload-webhook/request/use-case-fleet-dispatch/fleet-document-upload-webhook/request/use-case-document-import/fleet-document-upload-webhook/request/query-parameters"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query parameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"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":"code","inline":true,"attributes":{"content":"question_path_key"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maps the file to a document type in Qargo (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CMR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WEIGHT_NOTE"},"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":"code","inline":true,"attributes":{"content":"stop_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No*"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Qargo UUID of the stop to attach the document to"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop_group_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No*"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Qargo UUID of the stop group to attach the document to"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"*Provide either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop_group_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to identify where to attach the document."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/fleet-document-upload-webhook/request/use-case-fleet-dispatch/fleet-document-upload-webhook/request/use-case-document-import/fleet-document-upload-webhook/request/headers","deepLinkHash":"/webhooks-inbound/fleet-document-upload-webhook#webhooks-inbound/fleet-document-upload-webhook/request/use-case-fleet-dispatch/fleet-document-upload-webhook/request/use-case-document-import/fleet-document-upload-webhook/request/headers"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Headers"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Header"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"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":"code","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":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MIME type of the file (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/jpeg"},"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":"code","inline":true,"attributes":{"content":"Content-Disposition"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provides the filename: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachment; filename=\"POD.pdf\""},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/fleet-document-upload-webhook/request/use-case-fleet-dispatch/fleet-document-upload-webhook/request/use-case-document-import/fleet-document-upload-webhook/request/filename-handling","deepLinkHash":"/webhooks-inbound/fleet-document-upload-webhook#webhooks-inbound/fleet-document-upload-webhook/request/use-case-fleet-dispatch/fleet-document-upload-webhook/request/use-case-document-import/fleet-document-upload-webhook/request/filename-handling"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filename handling"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The uploaded file's name in Qargo is determined by:"},"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":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Disposition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" includes a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filename"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — that value is used, combined with the question path key default."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filename=\"pod1234.pdf\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with question path key default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POD.pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → stored as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pod1234_POD.pdf"},"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":"If no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Disposition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided — the default filename from the question path key configuration is used."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/fleet-document-upload-webhook/request/use-case-fleet-dispatch/fleet-document-upload-webhook/request/use-case-document-import/fleet-document-upload-webhook/request/example","deepLinkHash":"/webhooks-inbound/fleet-document-upload-webhook#webhooks-inbound/fleet-document-upload-webhook/request/use-case-fleet-dispatch/fleet-document-upload-webhook/request/use-case-document-import/fleet-document-upload-webhook/request/example"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -X POST \\\n  \"https://api.qargo.com/v1/webhook/fleet-document-upload\\\n  ?question_path_key=POD&stop_id=<stop_uuid>\" \\\n  -u \"<webhook_client_id>:<webhook_secret_id>\" \\\n  -H \"Content-Type: application/pdf\" \\\n  -H \"Content-Disposition: attachment; filename=POD.pdf\" \\\n  --data-binary @/path/to/document.pdf\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -X POST \\\n  \"https://api.qargo.com/v1/webhook/fleet-document-upload\\\n  ?question_path_key=POD&stop_id=<stop_uuid>\" \\\n  -u \"<webhook_client_id>:<webhook_secret_id>\" \\\n  -H \"Content-Type: application/pdf\" \\\n  -H \"Content-Disposition: attachment; filename=POD.pdf\" \\\n  --data-binary @/path/to/document.pdf\n"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuthWebhookCredentials","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"question_path_key","in":"query","schemaId":"schema_120","description":"The question path key to map the file in Qargo, for example: CMR/POD","required":true},{"name":"stop_id","in":"query","schemaId":"schema_121","description":"The stop ID to which the document is related"},{"name":"stop_group_id","in":"query","schemaId":"schema_122","description":"The stop group ID to which the document is related"}],"pointer":"/paths/~1v1~1webhook~1fleet-document-upload/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_123"}},"schemaId":"schema_123","pointer":"/paths/~1v1~1webhook~1fleet-document-upload/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/webhook/fleet-document-upload","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[{"name":"question_path_key","in":"query","required":true,"schemaId":"schema_120"},{"name":"stop_id","in":"query","required":false,"schemaId":"schema_121"},{"name":"stop_group_id","in":"query","required":false,"schemaId":"schema_122"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuthWebhookCredentials","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_123"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/webhook/fleet-document-upload","href":"use-case-document-import/fleet-document-upload-webhook","openApiOperationId":"fleet-document-upload-webhook","summary":"External Document Upload From A Fleet Application"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"schema_123","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_123"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}},"schemaId":"schema_106"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1webhook~1fleet-document-upload/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_106","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-document-import/fleet-document-upload-webhook"}],"panels":[]}]},"httpPath":"/v1/webhook/fleet-document-upload"},{"label":"External Document Update With Payload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-document-import/subcontractor-document-upload-webhook","routeSlug":"/docs/use-case-document-import/subcontractor-document-upload-webhook","metadata":{"seo":{"title":"External Document Update With Payload","description":"Upload a document to a specific stop on a subcontracted trip."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"subcontractor-document-upload-webhook","name":"External Document Update With Payload","isWebhook":false,"pointer":"/paths/~1v1~1webhook~1subco-document-upload/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"External Document Update With Payload","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":"Upload a document to a specific stop on a subcontracted trip."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This webhook uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Basic Auth"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (webhook credentials), not the OAuth credentials used for the API."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact integrations@qargo.com to request credentials."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/subcontractor-document-upload-webhook/request/use-case-subcontractor-dispatch/subcontractor-document-upload-webhook/request/use-case-document-import/subcontractor-document-upload-webhook/request/query-parameters","deepLinkHash":"/webhooks-inbound/subcontractor-document-upload-webhook#webhooks-inbound/subcontractor-document-upload-webhook/request/use-case-subcontractor-dispatch/subcontractor-document-upload-webhook/request/use-case-document-import/subcontractor-document-upload-webhook/request/query-parameters"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query parameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"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":"code","inline":true,"attributes":{"content":"question_path_key"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maps the file to a document type in Qargo (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CMR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WEIGHT_NOTE"},"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":"code","inline":true,"attributes":{"content":"stop_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Qargo UUID of the stop to attach the document to"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/subcontractor-document-upload-webhook/request/use-case-subcontractor-dispatch/subcontractor-document-upload-webhook/request/use-case-document-import/subcontractor-document-upload-webhook/request/headers","deepLinkHash":"/webhooks-inbound/subcontractor-document-upload-webhook#webhooks-inbound/subcontractor-document-upload-webhook/request/use-case-subcontractor-dispatch/subcontractor-document-upload-webhook/request/use-case-document-import/subcontractor-document-upload-webhook/request/headers"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Headers"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Header"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"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":"code","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":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MIME type of the file (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/jpeg"},"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":"code","inline":true,"attributes":{"content":"Content-Disposition"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provides the filename: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachment; filename=\"POD.pdf\""},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/subcontractor-document-upload-webhook/request/use-case-subcontractor-dispatch/subcontractor-document-upload-webhook/request/use-case-document-import/subcontractor-document-upload-webhook/request/filename-handling","deepLinkHash":"/webhooks-inbound/subcontractor-document-upload-webhook#webhooks-inbound/subcontractor-document-upload-webhook/request/use-case-subcontractor-dispatch/subcontractor-document-upload-webhook/request/use-case-document-import/subcontractor-document-upload-webhook/request/filename-handling"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filename handling"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The uploaded file's name in Qargo is determined by:"},"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":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Disposition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" includes a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filename"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — that value is used, combined with the question path key default."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filename=\"pod1234.pdf\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with question path key default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POD.pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → stored as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pod1234_POD.pdf"},"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":"If no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Disposition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided — the default filename from the question path key configuration is used."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/subcontractor-document-upload-webhook/request/use-case-subcontractor-dispatch/subcontractor-document-upload-webhook/request/use-case-document-import/subcontractor-document-upload-webhook/request/example","deepLinkHash":"/webhooks-inbound/subcontractor-document-upload-webhook#webhooks-inbound/subcontractor-document-upload-webhook/request/use-case-subcontractor-dispatch/subcontractor-document-upload-webhook/request/use-case-document-import/subcontractor-document-upload-webhook/request/example"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -X POST \\\n  \"https://api.qargo.com/v1/webhook/subco-document-upload\\\n  ?question_path_key=POD&stop_id=<stop_uuid>\" \\\n  -u \"<webhook_client_id>:<webhook_secret_id>\" \\\n  -H \"Content-Type: application/pdf\" \\\n  -H \"Content-Disposition: attachment; filename=POD.pdf\" \\\n  --data-binary @/path/to/document.pdf\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -X POST \\\n  \"https://api.qargo.com/v1/webhook/subco-document-upload\\\n  ?question_path_key=POD&stop_id=<stop_uuid>\" \\\n  -u \"<webhook_client_id>:<webhook_secret_id>\" \\\n  -H \"Content-Type: application/pdf\" \\\n  -H \"Content-Disposition: attachment; filename=POD.pdf\" \\\n  --data-binary @/path/to/document.pdf\n"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuthWebhookCredentials","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"question_path_key","in":"query","schemaId":"schema_120","description":"The question path key to map the file in Qargo, for example: CMR/POD","required":true},{"name":"stop_id","in":"query","schemaId":"schema_124","description":"The stop ID to which the document is related","required":true}],"pointer":"/paths/~1v1~1webhook~1subco-document-upload/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_123"}},"schemaId":"schema_123","pointer":"/paths/~1v1~1webhook~1subco-document-upload/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/webhook/subco-document-upload","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[{"name":"question_path_key","in":"query","required":true,"schemaId":"schema_120"},{"name":"stop_id","in":"query","required":true,"schemaId":"schema_124"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuthWebhookCredentials","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_123"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/webhook/subco-document-upload","href":"use-case-document-import/subcontractor-document-upload-webhook","openApiOperationId":"subcontractor-document-upload-webhook","summary":"External Document Update With Payload"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"schema_123","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_123"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}},"schemaId":"schema_106"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1webhook~1subco-document-upload/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_106","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-document-import/subcontractor-document-upload-webhook"}],"panels":[]}]},"httpPath":"/v1/webhook/subco-document-upload"}],"content":{"contentType":"group","meta":{"name":"Use case / Document import"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Use case / Document import","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":"This section provides an overview of all available methods to import documents into Qargo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"image","inline":true,"attributes":{"alt":"Document import paths overview","src":"https://api.qargo.com/docs/static/document_import_overview.svg"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/documents/document/upload_content","summary":"Upload Document Content","prefix":{"name":"post","color":"post"},"badges":[],"link":"/use-case-document-import/upload_document_content_v1_documents_document_upload_content_post","deprecated":false},{"title":"/v1/webhook/document-import","summary":"Generic Document Import","prefix":{"name":"post","color":"post"},"badges":[],"link":"/use-case-document-import/document-import-webhook","deprecated":false},{"title":"/v1/webhook/fleet-document-upload","summary":"External Document Upload From A Fleet Application","prefix":{"name":"post","color":"post"},"badges":[],"link":"/use-case-document-import/fleet-document-upload-webhook","deprecated":false},{"title":"/v1/webhook/subco-document-upload","summary":"External Document Update With Payload","prefix":{"name":"post","color":"post"},"badges":[],"link":"/use-case-document-import/subcontractor-document-upload-webhook","deprecated":false}]}]}]}]}},{"type":"group","label":"Use case / E-invoicing","link":"/docs/use-case-e-invoicing","routeSlug":"/docs/use-case-e-invoicing","items":[{"type":"link","label":"Supported formats","link":"/docs/use-case-e-invoicing/supported-formats","routeSlug":"/docs/use-case-e-invoicing/supported-formats","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Supported formats"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"use-case-e-invoicing/supported-formats"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported formats"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content-Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"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":"text","inline":true,"attributes":{"content":"JSON"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Qargo's own purchase invoice/credit note schema"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"XML (UBL)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/xml"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peppol-compliant UBL documents"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multipart"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"multipart/form-data"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON invoice data + supporting document files (PDF, XML, etc.)"},"children":[]}]}]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Attachments","link":"/docs/use-case-e-invoicing/attachments","routeSlug":"/docs/use-case-e-invoicing/attachments","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Attachments"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"use-case-e-invoicing/attachments"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attachments"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attachments (e.g. invoice PDF, CMR, proof of delivery) can be included in two ways:"},"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":"In JSON payloads"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array, where each item contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"document"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"base64"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"content_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"document_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filename"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"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":"In multipart uploads"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Send the JSON invoice data as the first part, followed by file attachments as additional parts."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-e-invoicing/e-invoicing-webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e-invoicing webhook endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for detailed examples of all formats and attachment handling."},"children":[]}]}]}]}],"panels":[]}]}},{"label":"Send E-Invoices","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-e-invoicing/e-invoicing-webhook","routeSlug":"/docs/use-case-e-invoicing/e-invoicing-webhook","metadata":{"seo":{"title":"Send E-Invoices","description":"Webhook to receive e-invoices in structured format or as file uploads."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"e-invoicing-webhook","name":"Send E-Invoices","isWebhook":false,"pointer":"/paths/~1v1~1webhook~1e-invoicing/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send E-Invoices","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":"Webhook to receive e-invoices in structured format or as file uploads."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/e-invoicing-webhook/request/use-case-e-invoicing/e-invoicing-webhook/request/supported-formats","deepLinkHash":"/webhooks-inbound/e-invoicing-webhook#webhooks-inbound/e-invoicing-webhook/request/use-case-e-invoicing/e-invoicing-webhook/request/supported-formats"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported Formats"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint accepts e-invoices in multiple formats:"},"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":"JSON payloads"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Structured data using application/json content type."},"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":"XML payloads"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Structured data using application/xml content type. Must be a valid UBL document."},"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":"File uploads"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": JSON + binary files (PDF, XML, etc.) using multipart/form-data."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/e-invoicing-webhook/request/use-case-e-invoicing/e-invoicing-webhook/request/multipart-upload-support","deepLinkHash":"/webhooks-inbound/e-invoicing-webhook#webhooks-inbound/e-invoicing-webhook/request/use-case-e-invoicing/e-invoicing-webhook/request/multipart-upload-support"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multipart Upload Support"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When using multipart form data, the endpoint expects:"},"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":"First part: JSON document (PurchaseEInvoiceInput or PurchaseECreditNoteInput). XML is not supported at the moment."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subsequent parts: Supporting documents (invoice PDF, CMR PDF, etc.)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/e-invoicing-webhook/request/use-case-e-invoicing/e-invoicing-webhook/request/examples","deepLinkHash":"/webhooks-inbound/e-invoicing-webhook#webhooks-inbound/e-invoicing-webhook/request/use-case-e-invoicing/e-invoicing-webhook/request/examples"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples"},"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":"JSON payload example (application/json)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"name\": \"INV-2023-001\",\n  \"date\": \"2023-01-15\",\n  \"due_date\": \"2023-02-15\",\n  \"invoice_type\": \"PURCHASE\",\n  \"currency\": \"EUR\",\n  \"total_excl_tax\": 999.99,\n  \"total_incl_tax\": 1209.99,\n  \"total_tax\": 210.00,\n  \"custom_fields\": {},\n  \"supplier\": {\n    \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n    \"name\": \"Supplier Company Ltd\",\n    \"vat_number\": \"BE1234.123.123\",\n    \"billing_location\": {\n      \"address\": \"Gaston Crommenlaan 4\",\n      \"city\": \"Gent\",\n      \"postal_code\": \"9050\",\n      \"country\": \"BE\"\n    }\n  },\n  \"customer_reference_numbers\": [\"12345\"],\n  \"line_items\": [\n    {\n      \"description\": \"International freight transport\",\n      \"amount\": 999.99,\n      \"currency\": \"EUR\",\n      \"tax_rate\": {\n        \"percentage\": 21.0,\n        \"name\": \"21% VAT\",\n        \"tax_type\": \"VAT\"\n      },\n      \"account\": {\n        \"code\": \"6000\"\n      },\n      \"references\": {\n        \"order_name\": \"OR-1234\"\n      }\n    }\n  ],\n  \"attachments\": [\n    {\n      \"document\": {\n        \"base64\": \"JVBERi0xLjQKJcfs... (truncated for brevity) ...\",\n        \"content_type\": \"application/pdf\",\n        \"document_type\": \"INVOICE\",\n        \"filename\": \"invoice_123.pdf\"\n      }\n    }\n  ]\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"name\": \"INV-2023-001\",\n  \"date\": \"2023-01-15\",\n  \"due_date\": \"2023-02-15\",\n  \"invoice_type\": \"PURCHASE\",\n  \"currency\": \"EUR\",\n  \"total_excl_tax\": 999.99,\n  \"total_incl_tax\": 1209.99,\n  \"total_tax\": 210.00,\n  \"custom_fields\": {},\n  \"supplier\": {\n    \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n    \"name\": \"Supplier Company Ltd\",\n    \"vat_number\": \"BE1234.123.123\",\n    \"billing_location\": {\n      \"address\": \"Gaston Crommenlaan 4\",\n      \"city\": \"Gent\",\n      \"postal_code\": \"9050\",\n      \"country\": \"BE\"\n    }\n  },\n  \"customer_reference_numbers\": [\"12345\"],\n  \"line_items\": [\n    {\n      \"description\": \"International freight transport\",\n      \"amount\": 999.99,\n      \"currency\": \"EUR\",\n      \"tax_rate\": {\n        \"percentage\": 21.0,\n        \"name\": \"21% VAT\",\n        \"tax_type\": \"VAT\"\n      },\n      \"account\": {\n        \"code\": \"6000\"\n      },\n      \"references\": {\n        \"order_name\": \"OR-1234\"\n      }\n    }\n  ],\n  \"attachments\": [\n    {\n      \"document\": {\n        \"base64\": \"JVBERi0xLjQKJcfs... (truncated for brevity) ...\",\n        \"content_type\": \"application/pdf\",\n        \"document_type\": \"INVOICE\",\n        \"filename\": \"invoice_123.pdf\"\n      }\n    }\n  ]\n}\n"},"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":"Credit note example (application/json)."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Note: credit notes do not have a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"due_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"name\": \"CN-2023-001\",\n  \"date\": \"2023-03-01\",\n  \"invoice_type\": \"PURCHASE_CREDIT_NOTE\",\n  \"currency\": \"EUR\",\n  \"total_excl_tax\": -200.00,\n  \"total_incl_tax\": -242.00,\n  \"total_tax\": -42.00,\n  \"supplier\": {\n    \"name\": \"Supplier Company Ltd\",\n    \"vat_number\": \"BE1234.123.123\"\n  },\n  \"customer_reference_numbers\": [\"12345\"],\n  \"line_items\": [\n    {\n      \"amount\": -200.00,\n      \"currency\": \"EUR\",\n      \"tax_rate\": {\n        \"percentage\": 21.0,\n        \"tax_type\": \"VAT\"\n      },\n      \"account\": {\n        \"code\": \"6000\"\n      }\n    }\n  ]\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"name\": \"CN-2023-001\",\n  \"date\": \"2023-03-01\",\n  \"invoice_type\": \"PURCHASE_CREDIT_NOTE\",\n  \"currency\": \"EUR\",\n  \"total_excl_tax\": -200.00,\n  \"total_incl_tax\": -242.00,\n  \"total_tax\": -42.00,\n  \"supplier\": {\n    \"name\": \"Supplier Company Ltd\",\n    \"vat_number\": \"BE1234.123.123\"\n  },\n  \"customer_reference_numbers\": [\"12345\"],\n  \"line_items\": [\n    {\n      \"amount\": -200.00,\n      \"currency\": \"EUR\",\n      \"tax_rate\": {\n        \"percentage\": 21.0,\n        \"tax_type\": \"VAT\"\n      },\n      \"account\": {\n        \"code\": \"6000\"\n      }\n    }\n  ]\n}\n"},"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":"XML payload example (application/xml)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<Invoice xmlns=\"urn:oasis:names:specification:ubl:schema:xsd:Invoice-2\" xmlns:cac=\"urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2\" xmlns:cbc=\"urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2\" xmlns:ccts=\"urn:un:unece:uncefact:documentation:2\" xmlns:ext=\"urn:oasis:names:specification:ubl:schema:xsd:CommonExtensionComponents-2\" xmlns:qdt=\"urn:oasis:names:specification:ubl:schema:xsd:QualifiedDatatypes-2\" xmlns:udt=\"urn:un:unece:uncefact:data:specification:UnqualifiedDataTypesSchemaModule:2\">\n    <cbc:CustomizationID>urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0</cbc:CustomizationID>\n    <cbc:ProfileID>urn:fdc:peppol.eu:2017:poacc:billing:01:1.0</cbc:ProfileID>\n    <cbc:ID>25900027</cbc:ID>\n    <cbc:IssueDate>2025-10-28</cbc:IssueDate>\n    <cbc:DueDate>2025-10-28</cbc:DueDate>\n    <cbc:InvoiceTypeCode>380</cbc:InvoiceTypeCode>\n    <cbc:DocumentCurrencyCode>EUR</cbc:DocumentCurrencyCode>\n    <cbc:BuyerReference>25900027</cbc:BuyerReference>\n    <cac:AdditionalDocumentReference>\n        <cbc:ID>600947</cbc:ID>\n        <cac:Attachment>\n            <cbc:EmbeddedDocumentBinaryObject mimeCode=\"application/pdf\" filename=\"25900027.pdf\">JVBERi0xLjQKJcfs... (truncated for brevity) ...</cbc:EmbeddedDocumentBinaryObject>\n        </cac:Attachment>\n    </cac:AdditionalDocumentReference>\n    <cac:AccountingSupplierParty>\n        <cac:Party>\n        <cbc:EndpointID schemeID=\"0208\">0564730040</cbc:EndpointID>\n        <cac:PartyName>\n            <cbc:Name>qargo-peppol-dev</cbc:Name>\n        </cac:PartyName>\n        <cac:PostalAddress>\n            <cbc:StreetName>Gaston Crommenlaan 4</cbc:StreetName>\n            <cbc:CityName>Gent</cbc:CityName>\n            <cbc:PostalZone>9050</cbc:PostalZone>\n            <cbc:CountrySubentity>Oost-Vlaanderen</cbc:CountrySubentity>\n            <cac:Country>\n            <cbc:IdentificationCode>BE</cbc:IdentificationCode>\n            </cac:Country>\n        </cac:PostalAddress>\n        <cac:PartyTaxScheme>\n            <cbc:CompanyID>BE0772640434</cbc:CompanyID>\n            <cac:TaxScheme>\n            <cbc:ID>VAT</cbc:ID>\n            </cac:TaxScheme>\n        </cac:PartyTaxScheme>\n        <cac:PartyLegalEntity>\n            <cbc:RegistrationName>qargo-peppol-dev</cbc:RegistrationName>\n            <cbc:CompanyID schemeID=\"0208\">0564730040</cbc:CompanyID>\n        </cac:PartyLegalEntity>\n        <cac:Contact>\n            <cbc:Telephone>+324854244512</cbc:Telephone>\n            <cbc:ElectronicMail>simon@qargo.com</cbc:ElectronicMail>\n        </cac:Contact>\n        </cac:Party>\n    </cac:AccountingSupplierParty>\n    <cac:AccountingCustomerParty>\n        <cac:Party>\n        <cbc:EndpointID schemeID=\"0208\">0772640434</cbc:EndpointID>\n        <cac:PartyName>\n            <cbc:Name>Qargo</cbc:Name>\n        </cac:PartyName>\n        <cac:PostalAddress>\n            <cbc:StreetName>Gaston Crommenlaan 4</cbc:StreetName>\n            <cbc:CityName>Gent</cbc:CityName>\n            <cbc:PostalZone>9050</cbc:PostalZone>\n            <cac:Country>\n            <cbc:IdentificationCode>BE</cbc:IdentificationCode>\n            </cac:Country>\n        </cac:PostalAddress>\n        <cac:PartyLegalEntity>\n            <cbc:RegistrationName languageID=\"nl\">Qargo</cbc:RegistrationName>\n            <cbc:CompanyID schemeID=\"0208\">0772640434</cbc:CompanyID>\n        </cac:PartyLegalEntity>\n        </cac:Party>\n    </cac:AccountingCustomerParty>\n    <cac:TaxTotal>\n        <cbc:TaxAmount currencyID=\"EUR\">162.71</cbc:TaxAmount>\n        <cac:TaxSubtotal>\n        <cbc:TaxableAmount currencyID=\"EUR\">774.83</cbc:TaxableAmount>\n        <cbc:TaxAmount currencyID=\"EUR\">162.71</cbc:TaxAmount>\n        <cac:TaxCategory>\n            <cbc:ID>S</cbc:ID>\n            <cbc:Percent>21.00</cbc:Percent>\n            <cac:TaxScheme>\n            <cbc:ID>VAT</cbc:ID>\n            </cac:TaxScheme>\n        </cac:TaxCategory>\n        </cac:TaxSubtotal>\n    </cac:TaxTotal>\n    <cac:LegalMonetaryTotal>\n        <cbc:LineExtensionAmount currencyID=\"EUR\">774.83</cbc:LineExtensionAmount>\n        <cbc:TaxExclusiveAmount currencyID=\"EUR\">774.83</cbc:TaxExclusiveAmount>\n        <cbc:TaxInclusiveAmount currencyID=\"EUR\">937.54</cbc:TaxInclusiveAmount>\n        <cbc:PayableAmount currencyID=\"EUR\">937.54</cbc:PayableAmount>\n    </cac:LegalMonetaryTotal>\n    <cac:InvoiceLine>\n        <cbc:ID>1</cbc:ID>\n        <cbc:InvoicedQuantity unitCode=\"EA\">1.0</cbc:InvoicedQuantity>\n        <cbc:LineExtensionAmount currencyID=\"EUR\">65.00</cbc:LineExtensionAmount>\n        <cac:Item>\n        <cbc:Name>Administratiekost</cbc:Name>\n        <cac:ClassifiedTaxCategory>\n            <cbc:ID>S</cbc:ID>\n            <cbc:Percent>21.00</cbc:Percent>\n            <cac:TaxScheme>\n            <cbc:ID>VAT</cbc:ID>\n            </cac:TaxScheme>\n        </cac:ClassifiedTaxCategory>\n        </cac:Item>\n        <cac:Price>\n        <cbc:PriceAmount currencyID=\"EUR\">65.0</cbc:PriceAmount>\n        </cac:Price>\n    </cac:InvoiceLine>\n    <cac:InvoiceLine>\n        <cbc:ID>2</cbc:ID>\n        <cbc:InvoicedQuantity unitCode=\"EA\">1.0</cbc:InvoicedQuantity>\n        <cbc:LineExtensionAmount currencyID=\"EUR\">709.83</cbc:LineExtensionAmount>\n        <cac:Item>\n        <cbc:Name>Transport charge</cbc:Name>\n        <cac:ClassifiedTaxCategory>\n            <cbc:ID>S</cbc:ID>\n            <cbc:Percent>21.00</cbc:Percent>\n            <cac:TaxScheme>\n            <cbc:ID>VAT</cbc:ID>\n            </cac:TaxScheme>\n        </cac:ClassifiedTaxCategory>\n        </cac:Item>\n        <cac:Price>\n        <cbc:PriceAmount currencyID=\"EUR\">709.83</cbc:PriceAmount>\n        </cac:Price>\n    </cac:InvoiceLine>\n</Invoice>\n","language":"xml"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<Invoice xmlns=\"urn:oasis:names:specification:ubl:schema:xsd:Invoice-2\" xmlns:cac=\"urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2\" xmlns:cbc=\"urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2\" xmlns:ccts=\"urn:un:unece:uncefact:documentation:2\" xmlns:ext=\"urn:oasis:names:specification:ubl:schema:xsd:CommonExtensionComponents-2\" xmlns:qdt=\"urn:oasis:names:specification:ubl:schema:xsd:QualifiedDatatypes-2\" xmlns:udt=\"urn:un:unece:uncefact:data:specification:UnqualifiedDataTypesSchemaModule:2\">\n    <cbc:CustomizationID>urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0</cbc:CustomizationID>\n    <cbc:ProfileID>urn:fdc:peppol.eu:2017:poacc:billing:01:1.0</cbc:ProfileID>\n    <cbc:ID>25900027</cbc:ID>\n    <cbc:IssueDate>2025-10-28</cbc:IssueDate>\n    <cbc:DueDate>2025-10-28</cbc:DueDate>\n    <cbc:InvoiceTypeCode>380</cbc:InvoiceTypeCode>\n    <cbc:DocumentCurrencyCode>EUR</cbc:DocumentCurrencyCode>\n    <cbc:BuyerReference>25900027</cbc:BuyerReference>\n    <cac:AdditionalDocumentReference>\n        <cbc:ID>600947</cbc:ID>\n        <cac:Attachment>\n            <cbc:EmbeddedDocumentBinaryObject mimeCode=\"application/pdf\" filename=\"25900027.pdf\">JVBERi0xLjQKJcfs... (truncated for brevity) ...</cbc:EmbeddedDocumentBinaryObject>\n        </cac:Attachment>\n    </cac:AdditionalDocumentReference>\n    <cac:AccountingSupplierParty>\n        <cac:Party>\n        <cbc:EndpointID schemeID=\"0208\">0564730040</cbc:EndpointID>\n        <cac:PartyName>\n            <cbc:Name>qargo-peppol-dev</cbc:Name>\n        </cac:PartyName>\n        <cac:PostalAddress>\n            <cbc:StreetName>Gaston Crommenlaan 4</cbc:StreetName>\n            <cbc:CityName>Gent</cbc:CityName>\n            <cbc:PostalZone>9050</cbc:PostalZone>\n            <cbc:CountrySubentity>Oost-Vlaanderen</cbc:CountrySubentity>\n            <cac:Country>\n            <cbc:IdentificationCode>BE</cbc:IdentificationCode>\n            </cac:Country>\n        </cac:PostalAddress>\n        <cac:PartyTaxScheme>\n            <cbc:CompanyID>BE0772640434</cbc:CompanyID>\n            <cac:TaxScheme>\n            <cbc:ID>VAT</cbc:ID>\n            </cac:TaxScheme>\n        </cac:PartyTaxScheme>\n        <cac:PartyLegalEntity>\n            <cbc:RegistrationName>qargo-peppol-dev</cbc:RegistrationName>\n            <cbc:CompanyID schemeID=\"0208\">0564730040</cbc:CompanyID>\n        </cac:PartyLegalEntity>\n        <cac:Contact>\n            <cbc:Telephone>+324854244512</cbc:Telephone>\n            <cbc:ElectronicMail>simon@qargo.com</cbc:ElectronicMail>\n        </cac:Contact>\n        </cac:Party>\n    </cac:AccountingSupplierParty>\n    <cac:AccountingCustomerParty>\n        <cac:Party>\n        <cbc:EndpointID schemeID=\"0208\">0772640434</cbc:EndpointID>\n        <cac:PartyName>\n            <cbc:Name>Qargo</cbc:Name>\n        </cac:PartyName>\n        <cac:PostalAddress>\n            <cbc:StreetName>Gaston Crommenlaan 4</cbc:StreetName>\n            <cbc:CityName>Gent</cbc:CityName>\n            <cbc:PostalZone>9050</cbc:PostalZone>\n            <cac:Country>\n            <cbc:IdentificationCode>BE</cbc:IdentificationCode>\n            </cac:Country>\n        </cac:PostalAddress>\n        <cac:PartyLegalEntity>\n            <cbc:RegistrationName languageID=\"nl\">Qargo</cbc:RegistrationName>\n            <cbc:CompanyID schemeID=\"0208\">0772640434</cbc:CompanyID>\n        </cac:PartyLegalEntity>\n        </cac:Party>\n    </cac:AccountingCustomerParty>\n    <cac:TaxTotal>\n        <cbc:TaxAmount currencyID=\"EUR\">162.71</cbc:TaxAmount>\n        <cac:TaxSubtotal>\n        <cbc:TaxableAmount currencyID=\"EUR\">774.83</cbc:TaxableAmount>\n        <cbc:TaxAmount currencyID=\"EUR\">162.71</cbc:TaxAmount>\n        <cac:TaxCategory>\n            <cbc:ID>S</cbc:ID>\n            <cbc:Percent>21.00</cbc:Percent>\n            <cac:TaxScheme>\n            <cbc:ID>VAT</cbc:ID>\n            </cac:TaxScheme>\n        </cac:TaxCategory>\n        </cac:TaxSubtotal>\n    </cac:TaxTotal>\n    <cac:LegalMonetaryTotal>\n        <cbc:LineExtensionAmount currencyID=\"EUR\">774.83</cbc:LineExtensionAmount>\n        <cbc:TaxExclusiveAmount currencyID=\"EUR\">774.83</cbc:TaxExclusiveAmount>\n        <cbc:TaxInclusiveAmount currencyID=\"EUR\">937.54</cbc:TaxInclusiveAmount>\n        <cbc:PayableAmount currencyID=\"EUR\">937.54</cbc:PayableAmount>\n    </cac:LegalMonetaryTotal>\n    <cac:InvoiceLine>\n        <cbc:ID>1</cbc:ID>\n        <cbc:InvoicedQuantity unitCode=\"EA\">1.0</cbc:InvoicedQuantity>\n        <cbc:LineExtensionAmount currencyID=\"EUR\">65.00</cbc:LineExtensionAmount>\n        <cac:Item>\n        <cbc:Name>Administratiekost</cbc:Name>\n        <cac:ClassifiedTaxCategory>\n            <cbc:ID>S</cbc:ID>\n            <cbc:Percent>21.00</cbc:Percent>\n            <cac:TaxScheme>\n            <cbc:ID>VAT</cbc:ID>\n            </cac:TaxScheme>\n        </cac:ClassifiedTaxCategory>\n        </cac:Item>\n        <cac:Price>\n        <cbc:PriceAmount currencyID=\"EUR\">65.0</cbc:PriceAmount>\n        </cac:Price>\n    </cac:InvoiceLine>\n    <cac:InvoiceLine>\n        <cbc:ID>2</cbc:ID>\n        <cbc:InvoicedQuantity unitCode=\"EA\">1.0</cbc:InvoicedQuantity>\n        <cbc:LineExtensionAmount currencyID=\"EUR\">709.83</cbc:LineExtensionAmount>\n        <cac:Item>\n        <cbc:Name>Transport charge</cbc:Name>\n        <cac:ClassifiedTaxCategory>\n            <cbc:ID>S</cbc:ID>\n            <cbc:Percent>21.00</cbc:Percent>\n            <cac:TaxScheme>\n            <cbc:ID>VAT</cbc:ID>\n            </cac:TaxScheme>\n        </cac:ClassifiedTaxCategory>\n        </cac:Item>\n        <cac:Price>\n        <cbc:PriceAmount currencyID=\"EUR\">709.83</cbc:PriceAmount>\n        </cac:Price>\n    </cac:InvoiceLine>\n</Invoice>\n"},"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":"Multipart Form Data example."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"POST /v1/webhook/e-invoicing\nContent-Type: multipart/form-data; boundary=----WebKitFormBoundaryABC123XYZ\n\n----WebKitFormBoundaryABC123XYZ\nContent-Disposition: form-data; name=\"document\"; filename=\"invoice_data.json\"\nContent-Type: application/json\n\n{\n  \"name\": \"INV-2023-001\",\n  \"date\": \"2023-01-15\",\n  \"due_date\": \"2023-02-15\",\n  \"invoice_type\": \"PURCHASE\",\n  \"currency\": \"EUR\",\n  \"total_excl_tax\": 999.99,\n  \"total_incl_tax\": 1209.99,\n  \"total_tax\": 210.00,\n  \"custom_fields\": {},\n  \"supplier\": {\n    \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n    \"name\": \"Supplier Company Ltd\",\n    \"vat_number\": \"BE1234.123.123\",\n    \"billing_location\": {\n      \"address\": \"Gaston Crommenlaan 4\",\n      \"city\": \"Gent\",\n      \"postal_code\": \"9050\",\n      \"country\": \"BE\"\n    }\n  },\n  \"customer_reference_numbers\": [\"12345\"],\n  \"line_items\": [\n    {\n      \"description\": \"International freight transport\",\n      \"amount\": 999.99,\n      \"currency\": \"EUR\",\n      \"tax_rate\": {\n        \"percentage\": 21.0,\n        \"name\": \"21% VAT\",\n        \"tax_type\": \"VAT\"\n      },\n      \"account\": {\n        \"code\": \"6000\"\n      },\n      \"references\": {\n        \"order_name\": \"OR-1234\"\n      }\n    }\n  ]\n}\n----WebKitFormBoundaryABC123XYZ\nContent-Disposition: form-data; name=\"invoice\"; filename=\"invoice_123.pdf\"\nContent-Type: application/pdf\n\n[binary PDF content]\n----WebKitFormBoundaryABC123XYZ\nContent-Disposition: form-data; name=\"cmr\"; filename=\"cmr_document.pdf\"\nContent-Type: application/pdf\n\n[binary PDF content]\n----WebKitFormBoundaryABC123XYZ--\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST /v1/webhook/e-invoicing\nContent-Type: multipart/form-data; boundary=----WebKitFormBoundaryABC123XYZ\n\n----WebKitFormBoundaryABC123XYZ\nContent-Disposition: form-data; name=\"document\"; filename=\"invoice_data.json\"\nContent-Type: application/json\n\n{\n  \"name\": \"INV-2023-001\",\n  \"date\": \"2023-01-15\",\n  \"due_date\": \"2023-02-15\",\n  \"invoice_type\": \"PURCHASE\",\n  \"currency\": \"EUR\",\n  \"total_excl_tax\": 999.99,\n  \"total_incl_tax\": 1209.99,\n  \"total_tax\": 210.00,\n  \"custom_fields\": {},\n  \"supplier\": {\n    \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n    \"name\": \"Supplier Company Ltd\",\n    \"vat_number\": \"BE1234.123.123\",\n    \"billing_location\": {\n      \"address\": \"Gaston Crommenlaan 4\",\n      \"city\": \"Gent\",\n      \"postal_code\": \"9050\",\n      \"country\": \"BE\"\n    }\n  },\n  \"customer_reference_numbers\": [\"12345\"],\n  \"line_items\": [\n    {\n      \"description\": \"International freight transport\",\n      \"amount\": 999.99,\n      \"currency\": \"EUR\",\n      \"tax_rate\": {\n        \"percentage\": 21.0,\n        \"name\": \"21% VAT\",\n        \"tax_type\": \"VAT\"\n      },\n      \"account\": {\n        \"code\": \"6000\"\n      },\n      \"references\": {\n        \"order_name\": \"OR-1234\"\n      }\n    }\n  ]\n}\n----WebKitFormBoundaryABC123XYZ\nContent-Disposition: form-data; name=\"invoice\"; filename=\"invoice_123.pdf\"\nContent-Type: application/pdf\n\n[binary PDF content]\n----WebKitFormBoundaryABC123XYZ\nContent-Disposition: form-data; name=\"cmr\"; filename=\"cmr_document.pdf\"\nContent-Type: application/pdf\n\n[binary PDF content]\n----WebKitFormBoundaryABC123XYZ--\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/e-invoicing-webhook/request/use-case-e-invoicing/e-invoicing-webhook/request/processing-notes-on-multipart-uploads","deepLinkHash":"/webhooks-inbound/e-invoicing-webhook#webhooks-inbound/e-invoicing-webhook/request/use-case-e-invoicing/e-invoicing-webhook/request/processing-notes-on-multipart-uploads"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processing Notes on Multipart Uploads"},"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":"First part must be the JSON document containing invoice/credit note data."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supporting documents follow as additional parts."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content-Type headers determine document processing."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuthWebhookCredentials","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_125"}},"schemaId":"schema_125","pointer":"/paths/~1v1~1webhook~1e-invoicing/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/webhook/e-invoicing","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuthWebhookCredentials","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_125"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/webhook/e-invoicing","href":"use-case-e-invoicing/e-invoicing-webhook","openApiOperationId":"e-invoicing-webhook","summary":"Send E-Invoices"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"schema_125","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_125"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}},"schemaId":"schema_106"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1webhook~1e-invoicing/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_106","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-e-invoicing/e-invoicing-webhook"}],"panels":[]}]},"httpPath":"/v1/webhook/e-invoicing"}],"content":{"contentType":"group","meta":{"name":"Use case / E-invoicing"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Use case / E-invoicing","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":"Required api role: not applicable"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose: This interface allows an external party to send e-invoices in a structured format."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-e-invoicing/e-invoicing-webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be used to send e-invoices to Qargo. The e-invoice can either be a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"purchase invoice"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"purchase credit note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/webhook/e-invoicing","summary":"Send E-Invoices","prefix":{"name":"post","color":"post"},"badges":[],"link":"/use-case-e-invoicing/e-invoicing-webhook","deprecated":false}]}]}]}]}},{"type":"group","label":"Use case / Fleet dispatch","link":"/docs/use-case-fleet-dispatch","routeSlug":"/docs/use-case-fleet-dispatch","items":[{"label":"External Document Upload From A Fleet Application","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-fleet-dispatch/fleet-document-upload-webhook","routeSlug":"/docs/use-case-fleet-dispatch/fleet-document-upload-webhook","metadata":{"seo":{"title":"External Document Upload From A Fleet Application","description":"Upload a document to a specific stop or stop group on a fleet-dispatched trip."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"fleet-document-upload-webhook","name":"External Document Upload From A Fleet Application","isWebhook":false,"pointer":"/paths/~1v1~1webhook~1fleet-document-upload/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"External Document Upload From A Fleet Application","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":"Upload a document to a specific stop or stop group on a fleet-dispatched trip."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This webhook uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Basic Auth"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (webhook credentials), not the OAuth credentials used for the API."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact integrations@qargo.com to request credentials."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/fleet-document-upload-webhook/request/use-case-fleet-dispatch/fleet-document-upload-webhook/request/use-case-document-import/fleet-document-upload-webhook/request/query-parameters","deepLinkHash":"/webhooks-inbound/fleet-document-upload-webhook#webhooks-inbound/fleet-document-upload-webhook/request/use-case-fleet-dispatch/fleet-document-upload-webhook/request/use-case-document-import/fleet-document-upload-webhook/request/query-parameters"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query parameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"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":"code","inline":true,"attributes":{"content":"question_path_key"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maps the file to a document type in Qargo (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CMR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WEIGHT_NOTE"},"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":"code","inline":true,"attributes":{"content":"stop_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No*"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Qargo UUID of the stop to attach the document to"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop_group_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No*"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Qargo UUID of the stop group to attach the document to"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"*Provide either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop_group_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to identify where to attach the document."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/fleet-document-upload-webhook/request/use-case-fleet-dispatch/fleet-document-upload-webhook/request/use-case-document-import/fleet-document-upload-webhook/request/headers","deepLinkHash":"/webhooks-inbound/fleet-document-upload-webhook#webhooks-inbound/fleet-document-upload-webhook/request/use-case-fleet-dispatch/fleet-document-upload-webhook/request/use-case-document-import/fleet-document-upload-webhook/request/headers"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Headers"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Header"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"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":"code","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":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MIME type of the file (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/jpeg"},"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":"code","inline":true,"attributes":{"content":"Content-Disposition"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provides the filename: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachment; filename=\"POD.pdf\""},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/fleet-document-upload-webhook/request/use-case-fleet-dispatch/fleet-document-upload-webhook/request/use-case-document-import/fleet-document-upload-webhook/request/filename-handling","deepLinkHash":"/webhooks-inbound/fleet-document-upload-webhook#webhooks-inbound/fleet-document-upload-webhook/request/use-case-fleet-dispatch/fleet-document-upload-webhook/request/use-case-document-import/fleet-document-upload-webhook/request/filename-handling"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filename handling"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The uploaded file's name in Qargo is determined by:"},"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":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Disposition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" includes a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filename"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — that value is used, combined with the question path key default."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filename=\"pod1234.pdf\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with question path key default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POD.pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → stored as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pod1234_POD.pdf"},"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":"If no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Disposition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided — the default filename from the question path key configuration is used."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/fleet-document-upload-webhook/request/use-case-fleet-dispatch/fleet-document-upload-webhook/request/use-case-document-import/fleet-document-upload-webhook/request/example","deepLinkHash":"/webhooks-inbound/fleet-document-upload-webhook#webhooks-inbound/fleet-document-upload-webhook/request/use-case-fleet-dispatch/fleet-document-upload-webhook/request/use-case-document-import/fleet-document-upload-webhook/request/example"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -X POST \\\n  \"https://api.qargo.com/v1/webhook/fleet-document-upload\\\n  ?question_path_key=POD&stop_id=<stop_uuid>\" \\\n  -u \"<webhook_client_id>:<webhook_secret_id>\" \\\n  -H \"Content-Type: application/pdf\" \\\n  -H \"Content-Disposition: attachment; filename=POD.pdf\" \\\n  --data-binary @/path/to/document.pdf\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -X POST \\\n  \"https://api.qargo.com/v1/webhook/fleet-document-upload\\\n  ?question_path_key=POD&stop_id=<stop_uuid>\" \\\n  -u \"<webhook_client_id>:<webhook_secret_id>\" \\\n  -H \"Content-Type: application/pdf\" \\\n  -H \"Content-Disposition: attachment; filename=POD.pdf\" \\\n  --data-binary @/path/to/document.pdf\n"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuthWebhookCredentials","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"question_path_key","in":"query","schemaId":"schema_120","description":"The question path key to map the file in Qargo, for example: CMR/POD","required":true},{"name":"stop_id","in":"query","schemaId":"schema_121","description":"The stop ID to which the document is related"},{"name":"stop_group_id","in":"query","schemaId":"schema_122","description":"The stop group ID to which the document is related"}],"pointer":"/paths/~1v1~1webhook~1fleet-document-upload/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_123"}},"schemaId":"schema_123","pointer":"/paths/~1v1~1webhook~1fleet-document-upload/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/webhook/fleet-document-upload","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[{"name":"question_path_key","in":"query","required":true,"schemaId":"schema_120"},{"name":"stop_id","in":"query","required":false,"schemaId":"schema_121"},{"name":"stop_group_id","in":"query","required":false,"schemaId":"schema_122"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuthWebhookCredentials","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_123"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/webhook/fleet-document-upload","href":"use-case-fleet-dispatch/fleet-document-upload-webhook","openApiOperationId":"fleet-document-upload-webhook","summary":"External Document Upload From A Fleet Application"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"schema_123","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_123"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}},"schemaId":"schema_106"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1webhook~1fleet-document-upload/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_106","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-fleet-dispatch/fleet-document-upload-webhook"}],"panels":[]}]},"httpPath":"/v1/webhook/fleet-document-upload"},{"label":"External Status Update From A Fleet Application","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-fleet-dispatch/fleet-status-update-webhook","routeSlug":"/docs/use-case-fleet-dispatch/fleet-status-update-webhook","metadata":{"seo":{"title":"External Status Update From A Fleet Application","description":"Webhook for updating the status, ETA, and data of stops from an external fleet application."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"fleet-status-update-webhook","name":"External Status Update From A Fleet Application","isWebhook":false,"pointer":"/paths/~1v1~1webhook~1fleet-status-update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"External Status Update From A Fleet Application","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":"Webhook for updating the status, ETA, and data of stops from an external fleet application."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that this webhook uses Basic Auth instead of the OAuth credentials used for the api."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please contact integrations@qargo.com to request credentials."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eta_start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eta_end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" date-time values must include a timezone offset,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2025-06-15T10:30:00Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2025-06-15T12:30:00+02:00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/fleet-status-update-webhook/request/use-case-fleet-dispatch/fleet-status-update-webhook/request/identifying-a-stop","deepLinkHash":"/webhooks-inbound/fleet-status-update-webhook#webhooks-inbound/fleet-status-update-webhook/request/use-case-fleet-dispatch/fleet-status-update-webhook/request/identifying-a-stop"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifying a stop"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each update targets either a single "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"stop"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"stop group"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Provide one per update entry."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"webhooks-inbound/fleet-status-update-webhook/request/use-case-fleet-dispatch/fleet-status-update-webhook/request/by-stop-id-(preferred)","deepLinkHash":"/webhooks-inbound/fleet-status-update-webhook#webhooks-inbound/fleet-status-update-webhook/request/use-case-fleet-dispatch/fleet-status-update-webhook/request/by-stop-id-(preferred)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By stop ID (preferred)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you know the Qargo stop UUID, pass it directly in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"updates\": [\n    {\n      \"stop\": { \"id\": \"a1b2c3d4-0000-0000-0000-000000000000\", \"status\": \"AT_STOP\" },\n      \"event_time\": \"2025-06-15T10:30:00Z\"\n    }\n  ]\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"updates\": [\n    {\n      \"stop\": { \"id\": \"a1b2c3d4-0000-0000-0000-000000000000\", \"status\": \"AT_STOP\" },\n      \"event_time\": \"2025-06-15T10:30:00Z\"\n    }\n  ]\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"webhooks-inbound/fleet-status-update-webhook/request/use-case-fleet-dispatch/fleet-status-update-webhook/request/by-matching-criteria","deepLinkHash":"/webhooks-inbound/fleet-status-update-webhook#webhooks-inbound/fleet-status-update-webhook/request/use-case-fleet-dispatch/fleet-status-update-webhook/request/by-matching-criteria"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By matching criteria"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the stop ID is not known, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop.match"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to find the stop by its related entities."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The matcher uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all provided criteria combined"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (AND logic) and expects "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"exactly one stop"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to match. If zero or multiple stops match, the update is discarded."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available matching fields:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"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":"code","inline":true,"attributes":{"content":"trip"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name.matches_any"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trip name(s)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name.matches_any"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order name(s)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer_reference_number.matches_any"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer reference number(s)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id.matches_any"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order UUID(s)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consignment"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference_number.matches_any"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Consignment reference number(s)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consignment"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order_sequence_number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Consignment sequence number within the order (integer)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference_number.matches_any"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stop reference number(s)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop_type"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PICKUP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELIVERY"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"matches_any"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field accepts a list of values — the stop matches if its value equals "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"any"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of them."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When multiple fields are provided, they are all required to match (AND)."},"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":"Example — match by order reference + stop type:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"updates\": [\n    {\n      \"stop\": {\n        \"match\": {\n          \"matches_all\": [\n            {\n              \"order\": { \"customer_reference_number\": { \"matches_any\": [\"REF-12345\"] } },\n              \"stop\": { \"stop_type\": \"DELIVERY\" }\n            }\n          ]\n        },\n        \"status\": \"COMPLETED\"\n      },\n      \"event_time\": \"2025-06-15T14:00:00Z\"\n    }\n  ]\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"updates\": [\n    {\n      \"stop\": {\n        \"match\": {\n          \"matches_all\": [\n            {\n              \"order\": { \"customer_reference_number\": { \"matches_any\": [\"REF-12345\"] } },\n              \"stop\": { \"stop_type\": \"DELIVERY\" }\n            }\n          ]\n        },\n        \"status\": \"COMPLETED\"\n      },\n      \"event_time\": \"2025-06-15T14:00:00Z\"\n    }\n  ]\n}\n"},"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":"Example — match by trip name + consignment reference:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"updates\": [\n    {\n      \"stop\": {\n        \"match\": {\n          \"matches_all\": [\n            {\n              \"trip\": { \"name\": { \"matches_any\": [\"T-20250615-001\"] } },\n              \"consignment\": { \"reference_number\": { \"matches_any\": [\"CONS-98765\"] } }\n            }\n          ]\n        },\n        \"status\": \"AT_STOP\",\n        \"eta_end\": \"2025-06-15T16:00:00Z\"\n      },\n      \"event_time\": \"2025-06-15T14:30:00Z\"\n    }\n  ]\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"updates\": [\n    {\n      \"stop\": {\n        \"match\": {\n          \"matches_all\": [\n            {\n              \"trip\": { \"name\": { \"matches_any\": [\"T-20250615-001\"] } },\n              \"consignment\": { \"reference_number\": { \"matches_any\": [\"CONS-98765\"] } }\n            }\n          ]\n        },\n        \"status\": \"AT_STOP\",\n        \"eta_end\": \"2025-06-15T16:00:00Z\"\n      },\n      \"event_time\": \"2025-06-15T14:30:00Z\"\n    }\n  ]\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/fleet-status-update-webhook/request/use-case-fleet-dispatch/fleet-status-update-webhook/request/stop-group-updates","deepLinkHash":"/webhooks-inbound/fleet-status-update-webhook#webhooks-inbound/fleet-status-update-webhook/request/use-case-fleet-dispatch/fleet-status-update-webhook/request/stop-group-updates"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stop group updates"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A stop group represents multiple stops grouped by activity and location. When updating via"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop_group"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the status applies to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all stops"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in that group. The stop group "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is always"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"required — matching by criteria is not supported for stop groups."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"updates\": [\n    {\n      \"stop_group\": {\n        \"id\": \"b2c3d4e5-0000-0000-0000-000000000000\",\n        \"status\": \"COMPLETED\"\n      },\n      \"event_time\": \"2025-06-15T16:00:00Z\"\n    }\n  ]\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"updates\": [\n    {\n      \"stop_group\": {\n        \"id\": \"b2c3d4e5-0000-0000-0000-000000000000\",\n        \"status\": \"COMPLETED\"\n      },\n      \"event_time\": \"2025-06-15T16:00:00Z\"\n    }\n  ]\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/fleet-status-update-webhook/request/use-case-fleet-dispatch/fleet-status-update-webhook/request/statuses","deepLinkHash":"/webhooks-inbound/fleet-status-update-webhook#webhooks-inbound/fleet-status-update-webhook/request/use-case-fleet-dispatch/fleet-status-update-webhook/request/statuses"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statuses"},"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":"code","inline":true,"attributes":{"content":"AT_STOP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the vehicle has arrived at the stop location."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the stop activity is finished."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Omit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to update only the ETA or data fields without changing the stop status."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuthWebhookCredentials","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FleetStatusUpdatePayload"}},"schemaId":"components/schemas/FleetStatusUpdatePayload","pointer":"/paths/~1v1~1webhook~1fleet-status-update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/webhook/fleet-status-update","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuthWebhookCredentials","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/FleetStatusUpdatePayload"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/webhook/fleet-status-update","href":"use-case-fleet-dispatch/fleet-status-update-webhook","openApiOperationId":"fleet-status-update-webhook","summary":"External Status Update From A Fleet Application"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/FleetStatusUpdatePayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FleetStatusUpdatePayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}},"schemaId":"schema_106"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1webhook~1fleet-status-update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_106","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-fleet-dispatch/fleet-status-update-webhook"}],"panels":[]}]},"httpPath":"/v1/webhook/fleet-status-update"},{"label":"Fleet Dispatch Payload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-fleet-dispatch/fleet-dispatch-payload","routeSlug":"/docs/use-case-fleet-dispatch/fleet-dispatch-payload","metadata":{"seo":{"title":"Fleet Dispatch Payload","description":"Payload for sending fleet app dispatches.In this case, we send the payload to an external endpoint for processing."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"fleet-dispatch-payload","name":"Fleet Dispatch Payload","isWebhook":false,"pointer":"/paths/https:~1~1<external-fleet-receiving-endpoint>/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fleet Dispatch Payload","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":"Payload for sending fleet app dispatches."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In this case, we send the payload to an external endpoint for processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, we send our standard "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FleetDispatch"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" schema,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"but the body can also be a custom mapped format."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_126"}},"schemaId":"schema_126","pointer":"/paths/https:~1~1<external-fleet-receiving-endpoint>/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"https://<external-fleet-receiving-endpoint>","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_126"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"https://<external-fleet-receiving-endpoint>","href":"use-case-fleet-dispatch/fleet-dispatch-payload","openApiOperationId":"fleet-dispatch-payload","summary":"Fleet Dispatch Payload"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"schema_126","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_126"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_127"}},"schemaId":"schema_127"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/https:~1~1<external-fleet-receiving-endpoint>/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_127","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_127"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-fleet-dispatch/fleet-dispatch-payload"}],"panels":[]}]},"httpPath":"https://<external-fleet-receiving-endpoint>"}],"content":{"contentType":"group","meta":{"name":"Use case / Fleet dispatch"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Use case / Fleet dispatch","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":"Required api role: not applicable (push/push)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose: This interface allows an external party to integrate with driver apps and on board computer systems."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fleet dispatch uses a push/push model: Qargo pushes a dispatch payload to an external endpoint."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The third party then updates Qargo using our webhook endpoint:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"image","inline":true,"attributes":{"alt":"dispatch flow","src":"https://api.qargo.com/docs/static/fleet_dispatch_flow.svg"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subsequent updates or cancellations will also be sent via this webhook, using the same payload format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The dispatch format has the following structure:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"image","inline":true,"attributes":{"alt":"dispatch payload","src":"https://api.qargo.com/docs/static/dispatch_fleet_payload.svg"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The destination of this webhook can be a RESTful interface or file base protocol like SFTP."},"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":"link","inline":true,"attributes":{"href":"/docs/use-case-fleet-dispatch/fleet-status-update-webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status update endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be used to send information about the stops back to Qargo."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status update date-time values, including "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eta_start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eta_end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", must include a timezone offset such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+02:00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/webhook/fleet-document-upload","summary":"External Document Upload From A Fleet Application","prefix":{"name":"post","color":"post"},"badges":[],"link":"/use-case-fleet-dispatch/fleet-document-upload-webhook","deprecated":false},{"title":"/v1/webhook/fleet-status-update","summary":"External Status Update From A Fleet Application","prefix":{"name":"post","color":"post"},"badges":[],"link":"/use-case-fleet-dispatch/fleet-status-update-webhook","deprecated":false},{"title":"https://<external-fleet-receiving-endpoint>","summary":"Fleet Dispatch Payload","prefix":{"name":"post","color":"post"},"badges":[],"link":"/use-case-fleet-dispatch/fleet-dispatch-payload","deprecated":false}]}]}]}]}},{"type":"group","label":"Use case / Intermodal [partner]","link":"/docs/use-case-intermodal-partner","routeSlug":"/docs/use-case-intermodal-partner","items":[{"label":"Intermodal Booking Status Update Webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-intermodal-partner/intermodal-booking-status-webhook","routeSlug":"/docs/use-case-intermodal-partner/intermodal-booking-status-webhook","metadata":{"seo":{"title":"Intermodal Booking Status Update Webhook","description":"Inbound webhook to receive intermodal booking status updates from the external intermodal booking system."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"intermodal-booking-status-webhook","name":"Intermodal Booking Status Update Webhook","isWebhook":false,"pointer":"/paths/~1v1~1webhook~1intermodal-status/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Intermodal Booking Status Update Webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Inbound webhook to receive intermodal booking status updates from the external intermodal booking system."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuthWebhookCredentials","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_128"}},"schemaId":"schema_128","pointer":"/paths/~1v1~1webhook~1intermodal-status/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/webhook/intermodal-status","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuthWebhookCredentials","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_128"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/webhook/intermodal-status","href":"use-case-intermodal-partner/intermodal-booking-status-webhook","openApiOperationId":"intermodal-booking-status-webhook","summary":"Intermodal Booking Status Update Webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"schema_128","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_128"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}},"schemaId":"schema_106"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1webhook~1intermodal-status/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_106","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-intermodal-partner/intermodal-booking-status-webhook"}],"panels":[]}]},"httpPath":"/v1/webhook/intermodal-status"},{"label":"Intermodal Booking Payload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-intermodal-partner/intermodal_booking_payloadhttps____intermodal_booking_receiving_payload__post","routeSlug":"/docs/use-case-intermodal-partner/intermodal_booking_payloadhttps____intermodal_booking_receiving_payload__post","metadata":{"seo":{"title":"Intermodal Booking Payload","description":"Outbound webhook to send intermodal bookings to the external intermodal booking system."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Intermodal_booking_payloadhttps____intermodal_booking_receiving_payload__post","name":"Intermodal Booking Payload","isWebhook":false,"pointer":"/paths/https:~1~1<intermodal-booking-receiving-payload>/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Intermodal Booking Payload","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Outbound webhook to send intermodal bookings to the external intermodal booking system."},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_129"}},"schemaId":"schema_129","pointer":"/paths/https:~1~1<intermodal-booking-receiving-payload>/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"https://<intermodal-booking-receiving-payload>","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_129"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"https://<intermodal-booking-receiving-payload>","href":"use-case-intermodal-partner/intermodal_booking_payloadhttps____intermodal_booking_receiving_payload__post","openApiOperationId":"Intermodal_booking_payloadhttps____intermodal_booking_receiving_payload__post","summary":"Intermodal Booking Payload"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"schema_129","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_129"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}},"schemaId":"schema_106"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/https:~1~1<intermodal-booking-receiving-payload>/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_106","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-intermodal-partner/intermodal_booking_payloadhttps____intermodal_booking_receiving_payload__post"}],"panels":[]}]},"httpPath":"https://<intermodal-booking-receiving-payload>"}],"content":{"contentType":"group","meta":{"name":"Use case / Intermodal [partner]"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Use case / Intermodal [partner]","showPageActions":true},{"nodeType":"markdoc","content":"Note: this is currently only a specification meant as a preview.\nImplementation is still pending."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/webhook/intermodal-status","summary":"Intermodal Booking Status Update Webhook","prefix":{"name":"post","color":"post"},"badges":[],"link":"/use-case-intermodal-partner/intermodal-booking-status-webhook","deprecated":false},{"title":"https://<intermodal-booking-receiving-payload>","summary":"Intermodal Booking Payload","prefix":{"name":"post","color":"post"},"badges":[],"link":"/use-case-intermodal-partner/intermodal_booking_payloadhttps____intermodal_booking_receiving_payload__post","deprecated":false}]}]}]}]}},{"type":"group","label":"Use case / Location booking","link":"/docs/use-case-location-booking","routeSlug":"/docs/use-case-location-booking","items":[{"type":"link","label":"Operations","link":"/docs/use-case-location-booking/operations","routeSlug":"/docs/use-case-location-booking/operations","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Operations"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"use-case-location-booking/operations"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operations"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each dispatch payload includes an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"operation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field indicating the type of action:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operation"},"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":"code","inline":true,"attributes":{"content":"CREATE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New booking request. The external system should create a time slot reservation."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UPDATE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Booking details have changed (e.g. updated time window, different vehicle)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCEL"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The booking is no longer needed and should be released."},"children":[]}]}]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Booking scenarios","link":"/docs/use-case-location-booking/booking-scenarios","routeSlug":"/docs/use-case-location-booking/booking-scenarios","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Booking scenarios"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"use-case-location-booking/booking-scenarios"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Booking scenarios"},"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":"scenario"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field indicates the direction of goods movement at the location:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scenario"},"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":"code","inline":true,"attributes":{"content":"INBOUND"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Goods are being delivered to the location (e.g. warehouse receiving)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OUTBOUND"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Goods are being picked up from the location (e.g. warehouse shipping)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INBOUND_OUTBOUND"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Both pickup and delivery happen at the same location in a single booking."},"children":[]}]}]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Status lifecycle","link":"/docs/use-case-location-booking/status-lifecycle","routeSlug":"/docs/use-case-location-booking/status-lifecycle","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Status lifecycle"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"use-case-location-booking/status-lifecycle"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status lifecycle"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The external system updates the booking status via the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-location-booking/location-booking-update-webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"booking update webhook"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"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":"code","inline":true,"attributes":{"content":"TO_REQUEST"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initial state - booking has not yet been sent to the external system."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REQUESTED"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Booking request sent, awaiting confirmation from the location."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BOOKED"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time slot confirmed by the location."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCELLED"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Booking was cancelled."},"children":[]}]}]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Payload structure","link":"/docs/use-case-location-booking/payload-structure","routeSlug":"/docs/use-case-location-booking/payload-structure","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Payload structure"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"use-case-location-booking/payload-structure"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payload structure"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The dispatch payload contains:"},"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":"Trip information"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": trip ID, name, and orders linked to the booking"},"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":"Booking details"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": booking ID, booking name, location address, and relevant stops"},"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":"Resources"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": vehicle, trailer, and resource allocations assigned to the trip"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The destination of the dispatch can be a RESTful interface or file-based protocol like SFTP."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Update payload","link":"/docs/use-case-location-booking/update-payload","routeSlug":"/docs/use-case-location-booking/update-payload","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Update payload"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"use-case-location-booking/update-payload"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update payload"},"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":"link","inline":true,"attributes":{"href":"/docs/use-case-location-booking/location-booking-update-webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"booking update webhook"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the inbound channel the external system uses to send booking confirmations, status changes, and execution status updates back to Qargo. Each update carries:"},"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":"Booking reference"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": either the Qargo booking "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"match"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (matching criteria agreed with the external system)"},"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":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": new booking status ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REQUESTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BOOKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCELLED"},"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":"Execution statuses"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": fine-grained status tracking with event times and remarks"},"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":"Question answers"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": answers to questions configured on the booking, mapped onto the order"},"children":[]}]}]}]}]}],"panels":[]}]}},{"label":"Location Booking Update Webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-location-booking/location-booking-update-webhook","routeSlug":"/docs/use-case-location-booking/location-booking-update-webhook","metadata":{"seo":{"title":"Location Booking Update Webhook","description":"Inbound webhook to receive location booking updates from external systems."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"location-booking-update-webhook","name":"Location Booking Update Webhook","isWebhook":false,"pointer":"/paths/~1v1~1webhook~1location-booking-update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Location Booking Update Webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Inbound webhook to receive location booking updates from external systems."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuthWebhookCredentials","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LocationBookingUpdatePayload"}},"schemaId":"components/schemas/LocationBookingUpdatePayload","pointer":"/paths/~1v1~1webhook~1location-booking-update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/webhook/location-booking-update","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuthWebhookCredentials","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LocationBookingUpdatePayload"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/webhook/location-booking-update","href":"use-case-location-booking/location-booking-update-webhook","openApiOperationId":"location-booking-update-webhook","summary":"Location Booking Update Webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/LocationBookingUpdatePayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LocationBookingUpdatePayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_130"}},"schemaId":"schema_130"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1webhook~1location-booking-update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_130","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_130"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-location-booking/location-booking-update-webhook"}],"panels":[]}]},"httpPath":"/v1/webhook/location-booking-update"},{"label":"Location Booking Dispatch Payload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-location-booking/location-dispatch-payload","routeSlug":"/docs/use-case-location-booking/location-dispatch-payload","metadata":{"seo":{"title":"Location Booking Dispatch Payload","description":"Payload for sending location booking dispatches."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"location-dispatch-payload","name":"Location Booking Dispatch Payload","isWebhook":false,"pointer":"/paths/https:~1~1<location-booking-receiving-endpoint>/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Location Booking Dispatch Payload","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":"Payload for sending location booking dispatches."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, we send our standard "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LocationDispatchOutput"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" schema,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"but the body can also be a custom mapped format."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_131"}},"schemaId":"schema_131","pointer":"/paths/https:~1~1<location-booking-receiving-endpoint>/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"https://<location-booking-receiving-endpoint>","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_131"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"https://<location-booking-receiving-endpoint>","href":"use-case-location-booking/location-dispatch-payload","openApiOperationId":"location-dispatch-payload","summary":"Location Booking Dispatch Payload"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"schema_131","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_131"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_132"}},"schemaId":"schema_132"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/https:~1~1<location-booking-receiving-endpoint>/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_132","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_132"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-location-booking/location-dispatch-payload"}],"panels":[]}]},"httpPath":"https://<location-booking-receiving-endpoint>"}],"content":{"contentType":"group","meta":{"name":"Use case / Location booking"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Use case / Location booking","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":"Required api role: not applicable (push/push)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose: This interface allows an external party to integrate with warehouse management systems and location booking platforms."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The location booking uses a push/push model: Qargo pushes a booking dispatch payload to an external endpoint."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The third party then updates Qargo with booking status changes using our webhook endpoint:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"image","inline":true,"attributes":{"alt":"location booking flow","src":"https://api.qargo.com/docs/static/location_booking_flow.svg"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/webhook/location-booking-update","summary":"Location Booking Update Webhook","prefix":{"name":"post","color":"post"},"badges":[],"link":"/use-case-location-booking/location-booking-update-webhook","deprecated":false},{"title":"https://<location-booking-receiving-endpoint>","summary":"Location Booking Dispatch Payload","prefix":{"name":"post","color":"post"},"badges":[],"link":"/use-case-location-booking/location-dispatch-payload","deprecated":false}]}]}]}]}},{"type":"group","label":"Use case / Master data sync","link":"/docs/use-case-master-data-sync","routeSlug":"/docs/use-case-master-data-sync","items":[{"label":"List Accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-master-data-sync/list_accounts_v1_accounting_accounts_get","routeSlug":"/docs/use-case-master-data-sync/list_accounts_v1_accounting_accounts_get","metadata":{"seo":{"title":"List Accounts","description":"Lists accounting codes (GL / nominal codes) for the tenant, with optional filtering and pagination."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"List_accounts_v1_accounting_accounts_get","name":"List Accounts","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1accounts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Accounts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists accounting codes (GL / nominal codes) for the tenant, with optional filtering and pagination."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_89","description":"Pagination cursor. Mutually exclusive with other query parameters"},{"name":"archived","in":"query","schemaId":"schema_90","description":"Filter by archived status. Omit to return all accounts."},{"name":"billing_entity_code","in":"query","schemaId":"schema_91","description":"Filter by billing entity code."},{"name":"code","in":"query","schemaId":"schema_92","description":"Accounting code to match exactly."},{"name":"code:in","in":"query","schemaId":"schema_93","description":"Accounting codes to match. Comma-separated list."}],"pointer":"/paths/~1v1~1accounting~1accounts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/accounts","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_89"},{"name":"archived","in":"query","required":false,"schemaId":"schema_90"},{"name":"billing_entity_code","in":"query","required":false,"schemaId":"schema_91"},{"name":"code","in":"query","required":false,"schemaId":"schema_92"},{"name":"code:in","in":"query","required":false,"schemaId":"schema_93"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/accounts","href":"use-case-master-data-sync/list_accounts_v1_accounting_accounts_get","openApiOperationId":"List_accounts_v1_accounting_accounts_get","summary":"List Accounts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListAccountOutput"}},"schemaId":"components/schemas/ListAccountOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1accounts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListAccountOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListAccountOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-master-data-sync/list_accounts_v1_accounting_accounts_get"}],"panels":[]}]},"httpPath":"/v1/accounting/accounts"},{"label":"Create An Exchange Rate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-master-data-sync/create_an_exchange_rate_v1_accounting_exchange_rate_post","routeSlug":"/docs/use-case-master-data-sync/create_an_exchange_rate_v1_accounting_exchange_rate_post","metadata":{"seo":{"title":"Create An Exchange Rate","description":"Creates an exchange rate in Qargo for the given currency pair and date."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create_an_exchange_rate_v1_accounting_exchange_rate_post","name":"Create An Exchange Rate","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1exchange-rate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create An Exchange Rate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates an exchange rate in Qargo for the given currency pair and date."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExchangeRateInput"}},"schemaId":"components/schemas/ExchangeRateInput","pointer":"/paths/~1v1~1accounting~1exchange-rate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/accounting/exchange-rate","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ExchangeRateInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/exchange-rate","href":"use-case-master-data-sync/create_an_exchange_rate_v1_accounting_exchange_rate_post","openApiOperationId":"Create_an_exchange_rate_v1_accounting_exchange_rate_post","summary":"Create An Exchange Rate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/ExchangeRateInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExchangeRateInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExchangeRateOutput"}},"schemaId":"components/schemas/ExchangeRateOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1exchange-rate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExchangeRateOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExchangeRateOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-master-data-sync/create_an_exchange_rate_v1_accounting_exchange_rate_post"}],"panels":[]}]},"httpPath":"/v1/accounting/exchange-rate"},{"label":"List Exchange Rates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-master-data-sync/list_exchange_rates_v1_accounting_exchange_rate_get","routeSlug":"/docs/use-case-master-data-sync/list_exchange_rates_v1_accounting_exchange_rate_get","metadata":{"seo":{"title":"List Exchange Rates","description":"Retrieves a list of exchange rates with optional currency and date filters. When filtering by both from_currency and to_currency, results are returned in the requested direction regardless of how they are stored internally."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"List_exchange_rates_v1_accounting_exchange_rate_get","name":"List Exchange Rates","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1exchange-rate/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Exchange Rates","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":"Retrieves a list of exchange rates with optional currency and date filters. When filtering by both from_currency and to_currency, results are returned in the requested direction regardless of how they are stored internally."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_89","description":"Pagination cursor. Mutually exclusive with other query parameters"},{"name":"from_currency","in":"query","schemaId":"schema_95","description":"Filter by source currency code (ISO 4217)."},{"name":"from_currency:in","in":"query","schemaId":"schema_96","description":"Source currency codes to match (ISO 4217). Comma-separated list. Matches either side of the currency pair."},{"name":"to_currency","in":"query","schemaId":"schema_97","description":"Filter by target currency code (ISO 4217)."},{"name":"to_currency:in","in":"query","schemaId":"schema_98","description":"Target currency codes to match (ISO 4217). Comma-separated list. Matches either side of the currency pair."},{"name":"exchange_rate_date:gte","in":"query","schemaId":"schema_99","description":"Filter exchange rates on or after this date."},{"name":"exchange_rate_date:lte","in":"query","schemaId":"schema_100","description":"Filter exchange rates on or before this date."}],"pointer":"/paths/~1v1~1accounting~1exchange-rate/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/exchange-rate","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_89"},{"name":"from_currency","in":"query","required":false,"schemaId":"schema_95"},{"name":"from_currency:in","in":"query","required":false,"schemaId":"schema_96"},{"name":"to_currency","in":"query","required":false,"schemaId":"schema_97"},{"name":"to_currency:in","in":"query","required":false,"schemaId":"schema_98"},{"name":"exchange_rate_date:gte","in":"query","required":false,"schemaId":"schema_99"},{"name":"exchange_rate_date:lte","in":"query","required":false,"schemaId":"schema_100"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/exchange-rate","href":"use-case-master-data-sync/list_exchange_rates_v1_accounting_exchange_rate_get","openApiOperationId":"List_exchange_rates_v1_accounting_exchange_rate_get","summary":"List Exchange Rates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListExchangeRateOutput"}},"schemaId":"components/schemas/ListExchangeRateOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1exchange-rate/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListExchangeRateOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListExchangeRateOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-master-data-sync/list_exchange_rates_v1_accounting_exchange_rate_get"}],"panels":[]}]},"httpPath":"/v1/accounting/exchange-rate"},{"label":"List Tax Rates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-master-data-sync/list_tax_rates_v1_accounting_tax_rates_get","routeSlug":"/docs/use-case-master-data-sync/list_tax_rates_v1_accounting_tax_rates_get","metadata":{"seo":{"title":"List Tax Rates","description":"Lists tax rates for the tenant, with optional filtering and pagination."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"List_tax_rates_v1_accounting_tax_rates_get","name":"List Tax Rates","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1tax-rates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Tax Rates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists tax rates for the tenant, with optional filtering and pagination."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_89","description":"Pagination cursor. Mutually exclusive with other query parameters"},{"name":"archived","in":"query","schemaId":"schema_90","description":"Filter by archived status. Omit to return all tax rates."},{"name":"billing_entity_code","in":"query","schemaId":"schema_91","description":"Filter by billing entity code."},{"name":"code","in":"query","schemaId":"schema_92","description":"Tax rate code to match exactly."},{"name":"code:in","in":"query","schemaId":"schema_93","description":"Tax rate codes to match. Comma-separated list."}],"pointer":"/paths/~1v1~1accounting~1tax-rates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/tax-rates","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_89"},{"name":"archived","in":"query","required":false,"schemaId":"schema_90"},{"name":"billing_entity_code","in":"query","required":false,"schemaId":"schema_91"},{"name":"code","in":"query","required":false,"schemaId":"schema_92"},{"name":"code:in","in":"query","required":false,"schemaId":"schema_93"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/tax-rates","href":"use-case-master-data-sync/list_tax_rates_v1_accounting_tax_rates_get","openApiOperationId":"List_tax_rates_v1_accounting_tax_rates_get","summary":"List Tax Rates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListTaxRateOutput"}},"schemaId":"components/schemas/ListTaxRateOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1tax-rates/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListTaxRateOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListTaxRateOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-master-data-sync/list_tax_rates_v1_accounting_tax_rates_get"}],"panels":[]}]},"httpPath":"/v1/accounting/tax-rates"},{"label":"Download Document","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-master-data-sync/download_document_v1_documents_document__id__download_get","routeSlug":"/docs/use-case-master-data-sync/download_document_v1_documents_document__id__download_get","metadata":{"seo":{"title":"Download Document","description":"Download a document by its ID. You can choose to download the document directly or stream it."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"download_document_v1_documents_document__id__download_get","name":"Download Document","isWebhook":false,"pointer":"/paths/~1v1~1documents~1document~1{id}~1download/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download Document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Download a document by its ID. You can choose to download the document directly or stream it."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1documents~1document~1{id}~1download/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"direct","in":"query","schemaId":"schema_105","description":"Query parameter to indicate that the response should contain all the document bytes"}],"pointer":"/paths/~1v1~1documents~1document~1{id}~1download/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/documents/document/{id}/download","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[{"name":"direct","in":"query","required":false,"schemaId":"schema_105"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/documents/document/{id}/download","href":"use-case-master-data-sync/download_document_v1_documents_document__id__download_get","openApiOperationId":"download_document_v1_documents_document__id__download_get","summary":"Download Document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}},"schemaId":"schema_106"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1documents~1document~1{id}~1download/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_106","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-master-data-sync/download_document_v1_documents_document__id__download_get"}],"panels":[]}]},"httpPath":"/v1/documents/document/{id}/download"},{"label":"List Companies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-master-data-sync/list_companies_v1_companies_company_get","routeSlug":"/docs/use-case-master-data-sync/list_companies_v1_companies_company_get","metadata":{"seo":{"title":"List Companies","description":"List Companies"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_companies_v1_companies_company_get","name":"List Companies","isWebhook":false,"pointer":"/paths/~1v1~1companies~1company/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Companies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_89","description":"Pagination cursor. Mutually exclusive with other query parameters"},{"name":"updated_after","in":"query","schemaId":"schema_108","description":"Filter to fetch the companies updated after this time. Format is ISO 8601 YYYY-MM-DDTHH:MM:SSZ"},{"name":"code","in":"query","schemaId":"schema_92","description":"Company code to match exactly."},{"name":"code:in","in":"query","schemaId":"schema_93","description":"Company codes to match. Comma-separated list."},{"name":"accounting_customer_code","in":"query","schemaId":"schema_109","description":"Accounting customer code to match exactly. Holds the code of the default billing entity."},{"name":"accounting_customer_code:in","in":"query","schemaId":"schema_110","description":"Accounting customer codes to match. Comma-separated list. Holds the code of the default billing entity."}],"pointer":"/paths/~1v1~1companies~1company/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/companies/company","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_89"},{"name":"updated_after","in":"query","required":false,"schemaId":"schema_108"},{"name":"code","in":"query","required":false,"schemaId":"schema_92"},{"name":"code:in","in":"query","required":false,"schemaId":"schema_93"},{"name":"accounting_customer_code","in":"query","required":false,"schemaId":"schema_109"},{"name":"accounting_customer_code:in","in":"query","required":false,"schemaId":"schema_110"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/companies/company","href":"use-case-master-data-sync/list_companies_v1_companies_company_get","openApiOperationId":"list_companies_v1_companies_company_get","summary":"List Companies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCompanyOutput"}},"schemaId":"components/schemas/ListCompanyOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1companies~1company/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCompanyOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCompanyOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-master-data-sync/list_companies_v1_companies_company_get"}],"panels":[]}]},"httpPath":"/v1/companies/company"},{"label":"Create Company","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-master-data-sync/create_company_v1_companies_company_post","routeSlug":"/docs/use-case-master-data-sync/create_company_v1_companies_company_post","metadata":{"seo":{"title":"Create Company","description":"Create Company"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_company_v1_companies_company_post","name":"Create Company","isWebhook":false,"pointer":"/paths/~1v1~1companies~1company/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Company","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyInput"}},"schemaId":"components/schemas/CompanyInput","pointer":"/paths/~1v1~1companies~1company/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/companies/company","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CompanyInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/companies/company","href":"use-case-master-data-sync/create_company_v1_companies_company_post","openApiOperationId":"create_company_v1_companies_company_post","summary":"Create Company"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/CompanyInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyDetailOutput"}},"schemaId":"components/schemas/CompanyDetailOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1companies~1company/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompanyDetailOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyDetailOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-master-data-sync/create_company_v1_companies_company_post"}],"panels":[]}]},"httpPath":"/v1/companies/company"},{"label":"Get Company Documents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-master-data-sync/get_company_documents_v1_companies_company__company_id__documents_get","routeSlug":"/docs/use-case-master-data-sync/get_company_documents_v1_companies_company__company_id__documents_get","metadata":{"seo":{"title":"Get Company Documents","description":"Fetch all documents for a specific company."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_company_documents_v1_companies_company__company_id__documents_get","name":"Get Company Documents","isWebhook":false,"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1documents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Company Documents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetch all documents for a specific company."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"company_id","in":"path","schemaId":"schema_133","required":true}],"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1documents/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_89","description":"Pagination cursor. Mutually exclusive with other query parameters"}],"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1documents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/companies/company/{company_id}/documents","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"company_id","in":"path","required":true,"schemaId":"schema_133"}],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_89"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/companies/company/{company_id}/documents","href":"use-case-master-data-sync/get_company_documents_v1_companies_company__company_id__documents_get","openApiOperationId":"get_company_documents_v1_companies_company__company_id__documents_get","summary":"Get Company Documents"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCompanyDocumentOutput"}},"schemaId":"components/schemas/ListCompanyDocumentOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1documents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCompanyDocumentOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCompanyDocumentOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-master-data-sync/get_company_documents_v1_companies_company__company_id__documents_get"}],"panels":[]}]},"httpPath":"/v1/companies/company/{company_id}/documents"},{"label":"Create Company Document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-master-data-sync/create_company_document_v1_companies_company__company_id__documents_post","routeSlug":"/docs/use-case-master-data-sync/create_company_document_v1_companies_company__company_id__documents_post","metadata":{"seo":{"title":"Create Company Document","description":"Upload a document for a specific company."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_company_document_v1_companies_company__company_id__documents_post","name":"Create Company Document","isWebhook":false,"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1documents/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Company Document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Upload a document for a specific company."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"company_id","in":"path","schemaId":"schema_133","required":true}],"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1documents/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UploadedCompanyDocumentWithValidity"}},"schemaId":"components/schemas/UploadedCompanyDocumentWithValidity","pointer":"/paths/~1v1~1companies~1company~1{company_id}~1documents/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/companies/company/{company_id}/documents","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"company_id","in":"path","required":true,"schemaId":"schema_133"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UploadedCompanyDocumentWithValidity"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/companies/company/{company_id}/documents","href":"use-case-master-data-sync/create_company_document_v1_companies_company__company_id__documents_post","openApiOperationId":"create_company_document_v1_companies_company__company_id__documents_post","summary":"Create Company Document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/UploadedCompanyDocumentWithValidity","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UploadedCompanyDocumentWithValidity"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyDocumentOutput"}},"schemaId":"components/schemas/CompanyDocumentOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1documents/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompanyDocumentOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyDocumentOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-master-data-sync/create_company_document_v1_companies_company__company_id__documents_post"}],"panels":[]}]},"httpPath":"/v1/companies/company/{company_id}/documents"},{"label":"List Company Validities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-master-data-sync/list_company_validities_v1_companies_company__company_id__validity_get","routeSlug":"/docs/use-case-master-data-sync/list_company_validities_v1_companies_company__company_id__validity_get","metadata":{"seo":{"title":"List Company Validities","description":"List all validities for a company."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"List_company_validities_v1_companies_company__company_id__validity_get","name":"List Company Validities","isWebhook":false,"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1validity/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Company Validities","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all validities for a company."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"company_id","in":"path","schemaId":"schema_133","required":true}],"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1validity/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_89","description":"Pagination cursor. Mutually exclusive with other query parameters"},{"name":"start_time","in":"query","schemaId":"schema_134","description":"Filter to fetch unavailabilities after this time"},{"name":"end_time","in":"query","schemaId":"schema_135","description":"Filter to fetch unavailabilities before this time"}],"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1validity/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/companies/company/{company_id}/validity","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"company_id","in":"path","required":true,"schemaId":"schema_133"}],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_89"},{"name":"start_time","in":"query","required":false,"schemaId":"schema_134"},{"name":"end_time","in":"query","required":false,"schemaId":"schema_135"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/companies/company/{company_id}/validity","href":"use-case-master-data-sync/list_company_validities_v1_companies_company__company_id__validity_get","openApiOperationId":"List_company_validities_v1_companies_company__company_id__validity_get","summary":"List Company Validities"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCompanyValidityOutput"}},"schemaId":"components/schemas/ListCompanyValidityOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1validity/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCompanyValidityOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCompanyValidityOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-master-data-sync/list_company_validities_v1_companies_company__company_id__validity_get"}],"panels":[]}]},"httpPath":"/v1/companies/company/{company_id}/validity"},{"label":"Create Company Validity Request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-master-data-sync/create_company_validity_request_v1_companies_company__company_id__validity_post","routeSlug":"/docs/use-case-master-data-sync/create_company_validity_request_v1_companies_company__company_id__validity_post","metadata":{"seo":{"title":"Create Company Validity Request","description":"Create a new validity request for a company."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create_company_validity_request_v1_companies_company__company_id__validity_post","name":"Create Company Validity Request","isWebhook":false,"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1validity/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Company Validity Request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new validity request for a company."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"company_id","in":"path","schemaId":"schema_133","required":true}],"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1validity/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyValidityInput"}},"schemaId":"components/schemas/CompanyValidityInput","pointer":"/paths/~1v1~1companies~1company~1{company_id}~1validity/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/companies/company/{company_id}/validity","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"company_id","in":"path","required":true,"schemaId":"schema_133"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CompanyValidityInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/companies/company/{company_id}/validity","href":"use-case-master-data-sync/create_company_validity_request_v1_companies_company__company_id__validity_post","openApiOperationId":"Create_company_validity_request_v1_companies_company__company_id__validity_post","summary":"Create Company Validity Request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/CompanyValidityInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyValidityInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyValidityOutput"}},"schemaId":"components/schemas/CompanyValidityOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1validity/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompanyValidityOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyValidityOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-master-data-sync/create_company_validity_request_v1_companies_company__company_id__validity_post"}],"panels":[]}]},"httpPath":"/v1/companies/company/{company_id}/validity"},{"label":"Get Company Validity","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-master-data-sync/get_company_validity_v1_companies_company__company_id__validity__id__get","routeSlug":"/docs/use-case-master-data-sync/get_company_validity_v1_companies_company__company_id__validity__id__get","metadata":{"seo":{"title":"Get Company Validity","description":"Fetches a specific validity for a company."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get_company_validity_v1_companies_company__company_id__validity__id__get","name":"Get Company Validity","isWebhook":false,"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1validity~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Company Validity","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches a specific validity for a company."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"company_id","in":"path","schemaId":"schema_133","required":true},{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1validity~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/companies/company/{company_id}/validity/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"company_id","in":"path","required":true,"schemaId":"schema_133"},{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/companies/company/{company_id}/validity/{id}","href":"use-case-master-data-sync/get_company_validity_v1_companies_company__company_id__validity__id__get","openApiOperationId":"Get_company_validity_v1_companies_company__company_id__validity__id__get","summary":"Get Company Validity"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyValidityOutput"}},"schemaId":"components/schemas/CompanyValidityOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1validity~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompanyValidityOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyValidityOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-master-data-sync/get_company_validity_v1_companies_company__company_id__validity__id__get"}],"panels":[]}]},"httpPath":"/v1/companies/company/{company_id}/validity/{id}"},{"label":"Update Company Validity","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-master-data-sync/update_company_validity_v1_companies_company__company_id__validity__id__put","routeSlug":"/docs/use-case-master-data-sync/update_company_validity_v1_companies_company__company_id__validity__id__put","metadata":{"seo":{"title":"Update Company Validity","description":"Update an existing validity for a company."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update_company_validity_v1_companies_company__company_id__validity__id__put","name":"Update Company Validity","isWebhook":false,"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1validity~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Company Validity","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update an existing validity for a company."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"company_id","in":"path","schemaId":"schema_133","required":true},{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1validity~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyValidityInput"}},"schemaId":"components/schemas/CompanyValidityInput","pointer":"/paths/~1v1~1companies~1company~1{company_id}~1validity~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/companies/company/{company_id}/validity/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"company_id","in":"path","required":true,"schemaId":"schema_133"},{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CompanyValidityInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/companies/company/{company_id}/validity/{id}","href":"use-case-master-data-sync/update_company_validity_v1_companies_company__company_id__validity__id__put","openApiOperationId":"Update_company_validity_v1_companies_company__company_id__validity__id__put","summary":"Update Company Validity"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/CompanyValidityInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyValidityInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyValidityOutput"}},"schemaId":"components/schemas/CompanyValidityOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1validity~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompanyValidityOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyValidityOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-master-data-sync/update_company_validity_v1_companies_company__company_id__validity__id__put"}],"panels":[]}]},"httpPath":"/v1/companies/company/{company_id}/validity/{id}"},{"label":"Delete Company Validity","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-master-data-sync/delete_company_validity_v1_companies_company__company_id__validity__id__delete","routeSlug":"/docs/use-case-master-data-sync/delete_company_validity_v1_companies_company__company_id__validity__id__delete","metadata":{"seo":{"title":"Delete Company Validity","description":"Delete a company validity."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete_company_validity_v1_companies_company__company_id__validity__id__delete","name":"Delete Company Validity","isWebhook":false,"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1validity~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Company Validity","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a company validity."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"company_id","in":"path","schemaId":"schema_133","required":true},{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1validity~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/companies/company/{company_id}/validity/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"company_id","in":"path","required":true,"schemaId":"schema_133"},{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["204","400","401","403","422","429","500","503"],"pointer":"/v1/companies/company/{company_id}/validity/{id}","href":"use-case-master-data-sync/delete_company_validity_v1_companies_company__company_id__validity__id__delete","openApiOperationId":"Delete_company_validity_v1_companies_company__company_id__validity__id__delete","summary":"Delete Company Validity"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful Response"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1validity~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-master-data-sync/delete_company_validity_v1_companies_company__company_id__validity__id__delete"}],"panels":[]}]},"httpPath":"/v1/companies/company/{company_id}/validity/{id}"},{"label":"Get Company Validity Documents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-master-data-sync/get_company_validity_documents_v1_companies_company__company_id__validity__id__documents_get","routeSlug":"/docs/use-case-master-data-sync/get_company_validity_documents_v1_companies_company__company_id__validity__id__documents_get","metadata":{"seo":{"title":"Get Company Validity Documents","description":"Fetch all documents associated with a specific company validity."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get_company_validity_documents_v1_companies_company__company_id__validity__id__documents_get","name":"Get Company Validity Documents","isWebhook":false,"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1validity~1{id}~1documents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Company Validity Documents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetch all documents associated with a specific company validity."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"company_id","in":"path","schemaId":"schema_133","required":true},{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1validity~1{id}~1documents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/companies/company/{company_id}/validity/{id}/documents","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"company_id","in":"path","required":true,"schemaId":"schema_133"},{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/companies/company/{company_id}/validity/{id}/documents","href":"use-case-master-data-sync/get_company_validity_documents_v1_companies_company__company_id__validity__id__documents_get","openApiOperationId":"Get_company_validity_documents_v1_companies_company__company_id__validity__id__documents_get","summary":"Get Company Validity Documents"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_136"}},"schemaId":"schema_136"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1validity~1{id}~1documents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_136","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_136"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-master-data-sync/get_company_validity_documents_v1_companies_company__company_id__validity__id__documents_get"}],"panels":[]}]},"httpPath":"/v1/companies/company/{company_id}/validity/{id}/documents"},{"label":"Get Company","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-master-data-sync/get_company_v1_companies_company__id__get","routeSlug":"/docs/use-case-master-data-sync/get_company_v1_companies_company__id__get","metadata":{"seo":{"title":"Get Company","description":"Get Company"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_company_v1_companies_company__id__get","name":"Get Company","isWebhook":false,"pointer":"/paths/~1v1~1companies~1company~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Company","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1companies~1company~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/companies/company/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/companies/company/{id}","href":"use-case-master-data-sync/get_company_v1_companies_company__id__get","openApiOperationId":"get_company_v1_companies_company__id__get","summary":"Get Company"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyDetailOutput"}},"schemaId":"components/schemas/CompanyDetailOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1companies~1company~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompanyDetailOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyDetailOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-master-data-sync/get_company_v1_companies_company__id__get"}],"panels":[]}]},"httpPath":"/v1/companies/company/{id}"},{"label":"Update Company","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-master-data-sync/update_company_v1_companies_company__id__put","routeSlug":"/docs/use-case-master-data-sync/update_company_v1_companies_company__id__put","metadata":{"seo":{"title":"Update Company","description":"Update Company"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_company_v1_companies_company__id__put","name":"Update Company","isWebhook":false,"pointer":"/paths/~1v1~1companies~1company~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Company","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1companies~1company~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyInput"}},"schemaId":"components/schemas/CompanyInput","pointer":"/paths/~1v1~1companies~1company~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/companies/company/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CompanyInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/companies/company/{id}","href":"use-case-master-data-sync/update_company_v1_companies_company__id__put","openApiOperationId":"update_company_v1_companies_company__id__put","summary":"Update Company"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/CompanyInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyDetailOutput"}},"schemaId":"components/schemas/CompanyDetailOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1companies~1company~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompanyDetailOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyDetailOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-master-data-sync/update_company_v1_companies_company__id__put"}],"panels":[]}]},"httpPath":"/v1/companies/company/{id}"},{"label":"Update Company","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-master-data-sync/update_company_v1_companies_company__id__patch","routeSlug":"/docs/use-case-master-data-sync/update_company_v1_companies_company__id__patch","metadata":{"seo":{"title":"Update Company","description":"Update Company"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_company_v1_companies_company__id__patch","name":"Update Company","isWebhook":false,"pointer":"/paths/~1v1~1companies~1company~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Company","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1companies~1company~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyPartialInput"}},"schemaId":"components/schemas/CompanyPartialInput","pointer":"/paths/~1v1~1companies~1company~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/companies/company/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CompanyPartialInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/companies/company/{id}","href":"use-case-master-data-sync/update_company_v1_companies_company__id__patch","openApiOperationId":"update_company_v1_companies_company__id__patch","summary":"Update Company"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/CompanyPartialInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyPartialInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyDetailOutput"}},"schemaId":"components/schemas/CompanyDetailOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1companies~1company~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompanyDetailOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyDetailOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-master-data-sync/update_company_v1_companies_company__id__patch"}],"panels":[]}]},"httpPath":"/v1/companies/company/{id}"},{"label":"Archive Company","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-master-data-sync/archive_company_v1_companies_company__id__delete","routeSlug":"/docs/use-case-master-data-sync/archive_company_v1_companies_company__id__delete","metadata":{"seo":{"title":"Archive Company","description":"Archive the company. This is a soft-delete: the company record is preserved and its archived_customer, archived_subcontractor, and archived_buyer_or_seller flags are set to true so it no longer appears in active lists."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Archive_company_v1_companies_company__id__delete","name":"Archive Company","isWebhook":false,"pointer":"/paths/~1v1~1companies~1company~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Archive Company","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":"Archive the company. This is a soft-delete: the company record is preserved and its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"archived_customer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"archived_subcontractor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"archived_buyer_or_seller"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flags are set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" so it no longer appears in active lists."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1companies~1company~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/companies/company/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["204","400","401","403","422","429","500","503"],"pointer":"/v1/companies/company/{id}","href":"use-case-master-data-sync/archive_company_v1_companies_company__id__delete","openApiOperationId":"Archive_company_v1_companies_company__id__delete","summary":"Archive Company"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful Response"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1companies~1company~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-master-data-sync/archive_company_v1_companies_company__id__delete"}],"panels":[]}]},"httpPath":"/v1/companies/company/{id}"},{"label":"Create Location","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-master-data-sync/create_location_v1_locations_location_post","routeSlug":"/docs/use-case-master-data-sync/create_location_v1_locations_location_post","metadata":{"seo":{"title":"Create Location","description":"Create a new location."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create_location_v1_locations_location_post","name":"Create Location","isWebhook":false,"pointer":"/paths/~1v1~1locations~1location/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Location","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new location."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LocationDetailInput"}},"schemaId":"components/schemas/LocationDetailInput","pointer":"/paths/~1v1~1locations~1location/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/locations/location","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LocationDetailInput"}},"responseCodes":["201","400","401","403","422","429","500","503"],"pointer":"/v1/locations/location","href":"use-case-master-data-sync/create_location_v1_locations_location_post","openApiOperationId":"Create_location_v1_locations_location_post","summary":"Create Location"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/LocationDetailInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LocationDetailInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LocationDetailOutput"}},"schemaId":"components/schemas/LocationDetailOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1locations~1location/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/LocationDetailOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LocationDetailOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-master-data-sync/create_location_v1_locations_location_post"}],"panels":[]}]},"httpPath":"/v1/locations/location"},{"label":"List Locations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-master-data-sync/list_locations_v1_locations_location_get","routeSlug":"/docs/use-case-master-data-sync/list_locations_v1_locations_location_get","metadata":{"seo":{"title":"List Locations","description":"List all locations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"List_locations_v1_locations_location_get","name":"List Locations","isWebhook":false,"pointer":"/paths/~1v1~1locations~1location/get","hasSamples":false},"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":"List all locations."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_89","description":"Pagination cursor. Mutually exclusive with other query parameters"},{"name":"external_id","in":"query","schemaId":"schema_137","description":"External location identifier to match exactly."},{"name":"external_id:in","in":"query","schemaId":"schema_138","description":"External location identifiers to match. Comma-separated list."}],"pointer":"/paths/~1v1~1locations~1location/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/locations/location","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_89"},{"name":"external_id","in":"query","required":false,"schemaId":"schema_137"},{"name":"external_id:in","in":"query","required":false,"schemaId":"schema_138"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/locations/location","href":"use-case-master-data-sync/list_locations_v1_locations_location_get","openApiOperationId":"List_locations_v1_locations_location_get","summary":"List Locations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListLocationOutput"}},"schemaId":"components/schemas/ListLocationOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1locations~1location/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListLocationOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListLocationOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-master-data-sync/list_locations_v1_locations_location_get"}],"panels":[]}]},"httpPath":"/v1/locations/location"},{"label":"Update Location","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-master-data-sync/update_location_v1_locations_location__location_id__put","routeSlug":"/docs/use-case-master-data-sync/update_location_v1_locations_location__location_id__put","metadata":{"seo":{"title":"Update Location","description":"Update an existing location. An update that moves the coordinates far from the current position creates and returns a new location, leaving already existing orders on the original one."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update_location_v1_locations_location__location_id__put","name":"Update Location","isWebhook":false,"pointer":"/paths/~1v1~1locations~1location~1{location_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Location","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update an existing location. An update that moves the coordinates far from the current position creates and returns a new location, leaving already existing orders on the original one."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_139","required":true}],"pointer":"/paths/~1v1~1locations~1location~1{location_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LocationDetailInput"}},"schemaId":"components/schemas/LocationDetailInput","pointer":"/paths/~1v1~1locations~1location~1{location_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/locations/location/{location_id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_139"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LocationDetailInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/locations/location/{location_id}","href":"use-case-master-data-sync/update_location_v1_locations_location__location_id__put","openApiOperationId":"Update_location_v1_locations_location__location_id__put","summary":"Update Location"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/LocationDetailInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LocationDetailInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LocationDetailOutput"}},"schemaId":"components/schemas/LocationDetailOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1locations~1location~1{location_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/LocationDetailOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LocationDetailOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-master-data-sync/update_location_v1_locations_location__location_id__put"}],"panels":[]}]},"httpPath":"/v1/locations/location/{location_id}"},{"label":"Patch Location","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-master-data-sync/patch_location_v1_locations_location__location_id__patch","routeSlug":"/docs/use-case-master-data-sync/patch_location_v1_locations_location__location_id__patch","metadata":{"seo":{"title":"Patch Location","description":"Partially update an existing location. An update that moves the coordinates far from the current position creates and returns a new location, leaving already existing orders on the original one."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Patch_location_v1_locations_location__location_id__patch","name":"Patch Location","isWebhook":false,"pointer":"/paths/~1v1~1locations~1location~1{location_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch Location","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Partially update an existing location. An update that moves the coordinates far from the current position creates and returns a new location, leaving already existing orders on the original one."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_139","required":true}],"pointer":"/paths/~1v1~1locations~1location~1{location_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PartialLocationDetailInput"}},"schemaId":"components/schemas/PartialLocationDetailInput","pointer":"/paths/~1v1~1locations~1location~1{location_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/locations/location/{location_id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_139"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PartialLocationDetailInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/locations/location/{location_id}","href":"use-case-master-data-sync/patch_location_v1_locations_location__location_id__patch","openApiOperationId":"Patch_location_v1_locations_location__location_id__patch","summary":"Patch Location"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/PartialLocationDetailInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PartialLocationDetailInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LocationDetailOutput"}},"schemaId":"components/schemas/LocationDetailOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1locations~1location~1{location_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/LocationDetailOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LocationDetailOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-master-data-sync/patch_location_v1_locations_location__location_id__patch"}],"panels":[]}]},"httpPath":"/v1/locations/location/{location_id}"},{"label":"Get Location","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-master-data-sync/get_location_v1_locations_location__location_id__get","routeSlug":"/docs/use-case-master-data-sync/get_location_v1_locations_location__location_id__get","metadata":{"seo":{"title":"Get Location","description":"Fetches a location."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get_location_v1_locations_location__location_id__get","name":"Get Location","isWebhook":false,"pointer":"/paths/~1v1~1locations~1location~1{location_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Location","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches a location."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_139","required":true}],"pointer":"/paths/~1v1~1locations~1location~1{location_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/locations/location/{location_id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_139"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/locations/location/{location_id}","href":"use-case-master-data-sync/get_location_v1_locations_location__location_id__get","openApiOperationId":"Get_location_v1_locations_location__location_id__get","summary":"Get Location"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LocationDetailOutput"}},"schemaId":"components/schemas/LocationDetailOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1locations~1location~1{location_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/LocationDetailOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LocationDetailOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-master-data-sync/get_location_v1_locations_location__location_id__get"}],"panels":[]}]},"httpPath":"/v1/locations/location/{location_id}"},{"label":"Create Resource","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-master-data-sync/create_resource_v1_resources_resource_post","routeSlug":"/docs/use-case-master-data-sync/create_resource_v1_resources_resource_post","metadata":{"seo":{"title":"Create Resource","description":"Create a new resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create_resource_v1_resources_resource_post","name":"Create Resource","isWebhook":false,"pointer":"/paths/~1v1~1resources~1resource/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Resource","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new resource."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_140"}},"schemaId":"schema_140","pointer":"/paths/~1v1~1resources~1resource/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/resources/resource","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_140"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/resources/resource","href":"use-case-master-data-sync/create_resource_v1_resources_resource_post","openApiOperationId":"Create_resource_v1_resources_resource_post","summary":"Create Resource"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"schema_140","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_140"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_141"}},"schemaId":"schema_141"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1resources~1resource/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_141","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_141"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-master-data-sync/create_resource_v1_resources_resource_post"}],"panels":[]}]},"httpPath":"/v1/resources/resource"},{"label":"List Resources","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-master-data-sync/list_resources_v1_resources_resource_get","routeSlug":"/docs/use-case-master-data-sync/list_resources_v1_resources_resource_get","metadata":{"seo":{"title":"List Resources","description":"List all resources"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"List_resources_v1_resources_resource_get","name":"List Resources","isWebhook":false,"pointer":"/paths/~1v1~1resources~1resource/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Resources","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all resources"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_89","description":"Pagination cursor. Mutually exclusive with other query parameters"},{"name":"updated_after","in":"query","schemaId":"schema_108","description":"Filter to fetch the resources updated after this time. Timestamp format is ISO 8601 YYYY-MM-DDTHH:MM:SSZ"},{"name":"external_id","in":"query","schemaId":"schema_137","description":"External resource identifier to match exactly."},{"name":"external_id:in","in":"query","schemaId":"schema_138","description":"External resource identifiers to match. Comma-separated list."},{"name":"resource_type","in":"query","schemaId":"schema_142","description":"Resource type to match exactly."},{"name":"resource_type:in","in":"query","schemaId":"schema_143","description":"Resource types to match. Comma-separated list."}],"pointer":"/paths/~1v1~1resources~1resource/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/resources/resource","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_89"},{"name":"updated_after","in":"query","required":false,"schemaId":"schema_108"},{"name":"external_id","in":"query","required":false,"schemaId":"schema_137"},{"name":"external_id:in","in":"query","required":false,"schemaId":"schema_138"},{"name":"resource_type","in":"query","required":false,"schemaId":"schema_142"},{"name":"resource_type:in","in":"query","required":false,"schemaId":"schema_143"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/resources/resource","href":"use-case-master-data-sync/list_resources_v1_resources_resource_get","openApiOperationId":"List_resources_v1_resources_resource_get","summary":"List Resources"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListResourceOutput"}},"schemaId":"components/schemas/ListResourceOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1resources~1resource/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListResourceOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListResourceOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-master-data-sync/list_resources_v1_resources_resource_get"}],"panels":[]}]},"httpPath":"/v1/resources/resource"},{"label":"Update Resource","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-master-data-sync/update_resource_v1_resources_resource__resource_id__put","routeSlug":"/docs/use-case-master-data-sync/update_resource_v1_resources_resource__resource_id__put","metadata":{"seo":{"title":"Update Resource","description":"Update an existing resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update_resource_v1_resources_resource__resource_id__put","name":"Update Resource","isWebhook":false,"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Resource","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update an existing resource."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"resource_id","in":"path","schemaId":"schema_144","required":true}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_140"}},"schemaId":"schema_140","pointer":"/paths/~1v1~1resources~1resource~1{resource_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/resources/resource/{resource_id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"resource_id","in":"path","required":true,"schemaId":"schema_144"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_140"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/resources/resource/{resource_id}","href":"use-case-master-data-sync/update_resource_v1_resources_resource__resource_id__put","openApiOperationId":"Update_resource_v1_resources_resource__resource_id__put","summary":"Update Resource"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"schema_140","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_140"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_145"}},"schemaId":"schema_145"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_145","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_145"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-master-data-sync/update_resource_v1_resources_resource__resource_id__put"}],"panels":[]}]},"httpPath":"/v1/resources/resource/{resource_id}"},{"label":"Patch Resource","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-master-data-sync/patch_resource_v1_resources_resource__resource_id__patch","routeSlug":"/docs/use-case-master-data-sync/patch_resource_v1_resources_resource__resource_id__patch","metadata":{"seo":{"title":"Patch Resource","description":"Partially update an existing resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Patch_resource_v1_resources_resource__resource_id__patch","name":"Patch Resource","isWebhook":false,"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch Resource","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Partially update an existing resource."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"resource_id","in":"path","schemaId":"schema_144","required":true}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_146"}},"schemaId":"schema_146","pointer":"/paths/~1v1~1resources~1resource~1{resource_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/resources/resource/{resource_id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"resource_id","in":"path","required":true,"schemaId":"schema_144"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_146"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/resources/resource/{resource_id}","href":"use-case-master-data-sync/patch_resource_v1_resources_resource__resource_id__patch","openApiOperationId":"Patch_resource_v1_resources_resource__resource_id__patch","summary":"Patch Resource"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"schema_146","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_146"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_147"}},"schemaId":"schema_147"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_147","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_147"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-master-data-sync/patch_resource_v1_resources_resource__resource_id__patch"}],"panels":[]}]},"httpPath":"/v1/resources/resource/{resource_id}"},{"label":"Archive Resource","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-master-data-sync/archive_resource_v1_resources_resource__resource_id__delete","routeSlug":"/docs/use-case-master-data-sync/archive_resource_v1_resources_resource__resource_id__delete","metadata":{"seo":{"title":"Archive Resource","description":"Archive a resource"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Archive_resource_v1_resources_resource__resource_id__delete","name":"Archive Resource","isWebhook":false,"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Archive Resource","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Archive a resource"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"resource_id","in":"path","schemaId":"schema_144","required":true}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/resources/resource/{resource_id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"resource_id","in":"path","required":true,"schemaId":"schema_144"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["204","400","401","403","422","429","500","503"],"pointer":"/v1/resources/resource/{resource_id}","href":"use-case-master-data-sync/archive_resource_v1_resources_resource__resource_id__delete","openApiOperationId":"Archive_resource_v1_resources_resource__resource_id__delete","summary":"Archive Resource"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful Response"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-master-data-sync/archive_resource_v1_resources_resource__resource_id__delete"}],"panels":[]}]},"httpPath":"/v1/resources/resource/{resource_id}"},{"label":"Get Resource","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-master-data-sync/get_resource_v1_resources_resource__resource_id__get","routeSlug":"/docs/use-case-master-data-sync/get_resource_v1_resources_resource__resource_id__get","metadata":{"seo":{"title":"Get Resource","description":"Fetches a resource"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get_resource_v1_resources_resource__resource_id__get","name":"Get Resource","isWebhook":false,"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Resource","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches a resource"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"resource_id","in":"path","schemaId":"schema_144","required":true}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/resources/resource/{resource_id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"resource_id","in":"path","required":true,"schemaId":"schema_144"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/resources/resource/{resource_id}","href":"use-case-master-data-sync/get_resource_v1_resources_resource__resource_id__get","openApiOperationId":"Get_resource_v1_resources_resource__resource_id__get","summary":"Get Resource"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_148"}},"schemaId":"schema_148"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_148","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_148"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-master-data-sync/get_resource_v1_resources_resource__resource_id__get"}],"panels":[]}]},"httpPath":"/v1/resources/resource/{resource_id}"},{"label":"List Resource Unavailabilities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-master-data-sync/list_resource_unavailabilities_v1_resources_resource__resource_id__unavailability_get","routeSlug":"/docs/use-case-master-data-sync/list_resource_unavailabilities_v1_resources_resource__resource_id__unavailability_get","metadata":{"seo":{"title":"List Resource Unavailabilities","description":"List all unavailabilities for a resource"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"List_resource_unavailabilities_v1_resources_resource__resource_id__unavailability_get","name":"List Resource Unavailabilities","isWebhook":false,"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1unavailability/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Resource Unavailabilities","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all unavailabilities for a resource"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"resource_id","in":"path","schemaId":"schema_144","required":true}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1unavailability/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_89","description":"Pagination cursor. Mutually exclusive with other query parameters"},{"name":"start_time","in":"query","schemaId":"schema_134","description":"Filter to fetch unavailabilities after this time"},{"name":"end_time","in":"query","schemaId":"schema_135","description":"Filter to fetch unavailabilities before this time"}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1unavailability/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/resources/resource/{resource_id}/unavailability","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"resource_id","in":"path","required":true,"schemaId":"schema_144"}],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_89"},{"name":"start_time","in":"query","required":false,"schemaId":"schema_134"},{"name":"end_time","in":"query","required":false,"schemaId":"schema_135"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/resources/resource/{resource_id}/unavailability","href":"use-case-master-data-sync/list_resource_unavailabilities_v1_resources_resource__resource_id__unavailability_get","openApiOperationId":"List_resource_unavailabilities_v1_resources_resource__resource_id__unavailability_get","summary":"List Resource Unavailabilities"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListResourceUnavailabilityOutput"}},"schemaId":"components/schemas/ListResourceUnavailabilityOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1unavailability/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListResourceUnavailabilityOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListResourceUnavailabilityOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-master-data-sync/list_resource_unavailabilities_v1_resources_resource__resource_id__unavailability_get"}],"panels":[]}]},"httpPath":"/v1/resources/resource/{resource_id}/unavailability"},{"label":"Create Resource Unavailabilities","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-master-data-sync/create_resource_unavailabilities_v1_resources_resource__resource_id__unavailability_post","routeSlug":"/docs/use-case-master-data-sync/create_resource_unavailabilities_v1_resources_resource__resource_id__unavailability_post","metadata":{"seo":{"title":"Create Resource Unavailabilities","description":"Create a new unavailability for a resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create_resource_unavailabilities_v1_resources_resource__resource_id__unavailability_post","name":"Create Resource Unavailabilities","isWebhook":false,"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1unavailability/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Resource Unavailabilities","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new unavailability for a resource."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"resource_id","in":"path","schemaId":"schema_144","required":true}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1unavailability/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ResourceUnavailabilityInput"}},"schemaId":"components/schemas/ResourceUnavailabilityInput","pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1unavailability/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/resources/resource/{resource_id}/unavailability","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"resource_id","in":"path","required":true,"schemaId":"schema_144"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ResourceUnavailabilityInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/resources/resource/{resource_id}/unavailability","href":"use-case-master-data-sync/create_resource_unavailabilities_v1_resources_resource__resource_id__unavailability_post","openApiOperationId":"Create_resource_unavailabilities_v1_resources_resource__resource_id__unavailability_post","summary":"Create Resource Unavailabilities"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/ResourceUnavailabilityInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ResourceUnavailabilityInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceUnavailabilityOutput"}},"schemaId":"components/schemas/ResourceUnavailabilityOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1unavailability/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ResourceUnavailabilityOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceUnavailabilityOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-master-data-sync/create_resource_unavailabilities_v1_resources_resource__resource_id__unavailability_post"}],"panels":[]}]},"httpPath":"/v1/resources/resource/{resource_id}/unavailability"},{"label":"Get Resource Unavailability","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-master-data-sync/get_resource_unavailability_v1_resources_resource__resource_id__unavailability__id__get","routeSlug":"/docs/use-case-master-data-sync/get_resource_unavailability_v1_resources_resource__resource_id__unavailability__id__get","metadata":{"seo":{"title":"Get Resource Unavailability","description":"Fetch a resource unavailability"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get_resource_unavailability_v1_resources_resource__resource_id__unavailability__id__get","name":"Get Resource Unavailability","isWebhook":false,"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1unavailability~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Resource Unavailability","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetch a resource unavailability"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"resource_id","in":"path","schemaId":"schema_144","required":true},{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1unavailability~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/resources/resource/{resource_id}/unavailability/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"resource_id","in":"path","required":true,"schemaId":"schema_144"},{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/resources/resource/{resource_id}/unavailability/{id}","href":"use-case-master-data-sync/get_resource_unavailability_v1_resources_resource__resource_id__unavailability__id__get","openApiOperationId":"Get_resource_unavailability_v1_resources_resource__resource_id__unavailability__id__get","summary":"Get Resource Unavailability"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceUnavailabilityOutput"}},"schemaId":"components/schemas/ResourceUnavailabilityOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1unavailability~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ResourceUnavailabilityOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceUnavailabilityOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-master-data-sync/get_resource_unavailability_v1_resources_resource__resource_id__unavailability__id__get"}],"panels":[]}]},"httpPath":"/v1/resources/resource/{resource_id}/unavailability/{id}"},{"label":"Update Resource Unavailabilities","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-master-data-sync/update_resource_unavailabilities_v1_resources_resource__resource_id__unavailability__id__put","routeSlug":"/docs/use-case-master-data-sync/update_resource_unavailabilities_v1_resources_resource__resource_id__unavailability__id__put","metadata":{"seo":{"title":"Update Resource Unavailabilities","description":"Update an existing unavailability for a resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update_resource_unavailabilities_v1_resources_resource__resource_id__unavailability__id__put","name":"Update Resource Unavailabilities","isWebhook":false,"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1unavailability~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Resource Unavailabilities","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update an existing unavailability for a resource."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"resource_id","in":"path","schemaId":"schema_144","required":true},{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1unavailability~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ResourceUnavailabilityInput"}},"schemaId":"components/schemas/ResourceUnavailabilityInput","pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1unavailability~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/resources/resource/{resource_id}/unavailability/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"resource_id","in":"path","required":true,"schemaId":"schema_144"},{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ResourceUnavailabilityInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/resources/resource/{resource_id}/unavailability/{id}","href":"use-case-master-data-sync/update_resource_unavailabilities_v1_resources_resource__resource_id__unavailability__id__put","openApiOperationId":"Update_resource_unavailabilities_v1_resources_resource__resource_id__unavailability__id__put","summary":"Update Resource Unavailabilities"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/ResourceUnavailabilityInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ResourceUnavailabilityInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceUnavailabilityOutput"}},"schemaId":"components/schemas/ResourceUnavailabilityOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1unavailability~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ResourceUnavailabilityOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceUnavailabilityOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-master-data-sync/update_resource_unavailabilities_v1_resources_resource__resource_id__unavailability__id__put"}],"panels":[]}]},"httpPath":"/v1/resources/resource/{resource_id}/unavailability/{id}"},{"label":"Delete Resource Unavailabilities","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-master-data-sync/delete_resource_unavailabilities_v1_resources_resource__resource_id__unavailability__id__delete","routeSlug":"/docs/use-case-master-data-sync/delete_resource_unavailabilities_v1_resources_resource__resource_id__unavailability__id__delete","metadata":{"seo":{"title":"Delete Resource Unavailabilities","description":"Delete a resource unavailability"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete_resource_unavailabilities_v1_resources_resource__resource_id__unavailability__id__delete","name":"Delete Resource Unavailabilities","isWebhook":false,"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1unavailability~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Resource Unavailabilities","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a resource unavailability"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"resource_id","in":"path","schemaId":"schema_144","required":true},{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1unavailability~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/resources/resource/{resource_id}/unavailability/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"resource_id","in":"path","required":true,"schemaId":"schema_144"},{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["204","400","401","403","422","429","500","503"],"pointer":"/v1/resources/resource/{resource_id}/unavailability/{id}","href":"use-case-master-data-sync/delete_resource_unavailabilities_v1_resources_resource__resource_id__unavailability__id__delete","openApiOperationId":"Delete_resource_unavailabilities_v1_resources_resource__resource_id__unavailability__id__delete","summary":"Delete Resource Unavailabilities"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful Response"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1unavailability~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-master-data-sync/delete_resource_unavailabilities_v1_resources_resource__resource_id__unavailability__id__delete"}],"panels":[]}]},"httpPath":"/v1/resources/resource/{resource_id}/unavailability/{id}"},{"label":"List Resource Validities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-master-data-sync/list_resource_validities_v1_resources_resource__resource_id__validity_get","routeSlug":"/docs/use-case-master-data-sync/list_resource_validities_v1_resources_resource__resource_id__validity_get","metadata":{"seo":{"title":"List Resource Validities","description":"List all validities for a resource"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"List_resource_validities_v1_resources_resource__resource_id__validity_get","name":"List Resource Validities","isWebhook":false,"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1validity/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Resource Validities","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all validities for a resource"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"resource_id","in":"path","schemaId":"schema_144","required":true}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1validity/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_89","description":"Pagination cursor. Mutually exclusive with other query parameters"},{"name":"start_time","in":"query","schemaId":"schema_134","description":"Filter to fetch unavailabilities after this time"},{"name":"end_time","in":"query","schemaId":"schema_135","description":"Filter to fetch unavailabilities before this time"}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1validity/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/resources/resource/{resource_id}/validity","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"resource_id","in":"path","required":true,"schemaId":"schema_144"}],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_89"},{"name":"start_time","in":"query","required":false,"schemaId":"schema_134"},{"name":"end_time","in":"query","required":false,"schemaId":"schema_135"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/resources/resource/{resource_id}/validity","href":"use-case-master-data-sync/list_resource_validities_v1_resources_resource__resource_id__validity_get","openApiOperationId":"List_resource_validities_v1_resources_resource__resource_id__validity_get","summary":"List Resource Validities"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListResourceValidityOutput"}},"schemaId":"components/schemas/ListResourceValidityOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1validity/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListResourceValidityOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListResourceValidityOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-master-data-sync/list_resource_validities_v1_resources_resource__resource_id__validity_get"}],"panels":[]}]},"httpPath":"/v1/resources/resource/{resource_id}/validity"},{"label":"Create Resource Validity Request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-master-data-sync/create_resource_validity_request_v1_resources_resource__resource_id__validity_post","routeSlug":"/docs/use-case-master-data-sync/create_resource_validity_request_v1_resources_resource__resource_id__validity_post","metadata":{"seo":{"title":"Create Resource Validity Request","description":"Create a new validity request for a resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create_resource_validity_request_v1_resources_resource__resource_id__validity_post","name":"Create Resource Validity Request","isWebhook":false,"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1validity/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Resource Validity Request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new validity request for a resource."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"resource_id","in":"path","schemaId":"schema_144","required":true}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1validity/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ResourceValidityInput"}},"schemaId":"components/schemas/ResourceValidityInput","pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1validity/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/resources/resource/{resource_id}/validity","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"resource_id","in":"path","required":true,"schemaId":"schema_144"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ResourceValidityInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/resources/resource/{resource_id}/validity","href":"use-case-master-data-sync/create_resource_validity_request_v1_resources_resource__resource_id__validity_post","openApiOperationId":"Create_resource_validity_request_v1_resources_resource__resource_id__validity_post","summary":"Create Resource Validity Request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/ResourceValidityInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ResourceValidityInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceValidityOutput"}},"schemaId":"components/schemas/ResourceValidityOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1validity/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ResourceValidityOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceValidityOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-master-data-sync/create_resource_validity_request_v1_resources_resource__resource_id__validity_post"}],"panels":[]}]},"httpPath":"/v1/resources/resource/{resource_id}/validity"},{"label":"Get Resource Validity","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-master-data-sync/get_resource_validity_v1_resources_resource__resource_id__validity__id__get","routeSlug":"/docs/use-case-master-data-sync/get_resource_validity_v1_resources_resource__resource_id__validity__id__get","metadata":{"seo":{"title":"Get Resource Validity","description":"Fetches a specific validity for a resource"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get_resource_validity_v1_resources_resource__resource_id__validity__id__get","name":"Get Resource Validity","isWebhook":false,"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1validity~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Resource Validity","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches a specific validity for a resource"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"resource_id","in":"path","schemaId":"schema_144","required":true},{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1validity~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/resources/resource/{resource_id}/validity/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"resource_id","in":"path","required":true,"schemaId":"schema_144"},{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/resources/resource/{resource_id}/validity/{id}","href":"use-case-master-data-sync/get_resource_validity_v1_resources_resource__resource_id__validity__id__get","openApiOperationId":"Get_resource_validity_v1_resources_resource__resource_id__validity__id__get","summary":"Get Resource Validity"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceValidityOutput"}},"schemaId":"components/schemas/ResourceValidityOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1validity~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ResourceValidityOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceValidityOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-master-data-sync/get_resource_validity_v1_resources_resource__resource_id__validity__id__get"}],"panels":[]}]},"httpPath":"/v1/resources/resource/{resource_id}/validity/{id}"},{"label":"Update Resource Validity","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-master-data-sync/update_resource_validity_v1_resources_resource__resource_id__validity__id__put","routeSlug":"/docs/use-case-master-data-sync/update_resource_validity_v1_resources_resource__resource_id__validity__id__put","metadata":{"seo":{"title":"Update Resource Validity","description":"Update an existing validity for a resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update_resource_validity_v1_resources_resource__resource_id__validity__id__put","name":"Update Resource Validity","isWebhook":false,"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1validity~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Resource Validity","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update an existing validity for a resource."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"resource_id","in":"path","schemaId":"schema_144","required":true},{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1validity~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ResourceValidityInput"}},"schemaId":"components/schemas/ResourceValidityInput","pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1validity~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/resources/resource/{resource_id}/validity/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"resource_id","in":"path","required":true,"schemaId":"schema_144"},{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ResourceValidityInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/resources/resource/{resource_id}/validity/{id}","href":"use-case-master-data-sync/update_resource_validity_v1_resources_resource__resource_id__validity__id__put","openApiOperationId":"Update_resource_validity_v1_resources_resource__resource_id__validity__id__put","summary":"Update Resource Validity"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/ResourceValidityInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ResourceValidityInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceValidityOutput"}},"schemaId":"components/schemas/ResourceValidityOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1validity~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ResourceValidityOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceValidityOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-master-data-sync/update_resource_validity_v1_resources_resource__resource_id__validity__id__put"}],"panels":[]}]},"httpPath":"/v1/resources/resource/{resource_id}/validity/{id}"},{"label":"Delete Resource Validity","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-master-data-sync/delete_resource_validity_v1_resources_resource__resource_id__validity__id__delete","routeSlug":"/docs/use-case-master-data-sync/delete_resource_validity_v1_resources_resource__resource_id__validity__id__delete","metadata":{"seo":{"title":"Delete Resource Validity","description":"Delete a resource validity"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete_resource_validity_v1_resources_resource__resource_id__validity__id__delete","name":"Delete Resource Validity","isWebhook":false,"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1validity~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Resource Validity","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a resource validity"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"resource_id","in":"path","schemaId":"schema_144","required":true},{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1validity~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/resources/resource/{resource_id}/validity/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"resource_id","in":"path","required":true,"schemaId":"schema_144"},{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["204","400","401","403","422","429","500","503"],"pointer":"/v1/resources/resource/{resource_id}/validity/{id}","href":"use-case-master-data-sync/delete_resource_validity_v1_resources_resource__resource_id__validity__id__delete","openApiOperationId":"Delete_resource_validity_v1_resources_resource__resource_id__validity__id__delete","summary":"Delete Resource Validity"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful Response"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1validity~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-master-data-sync/delete_resource_validity_v1_resources_resource__resource_id__validity__id__delete"}],"panels":[]}]},"httpPath":"/v1/resources/resource/{resource_id}/validity/{id}"},{"label":"Get Resource Validity Documents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-master-data-sync/get_resource_validity_documents_v1_resources_resource__resource_id__validity__id__documents_get","routeSlug":"/docs/use-case-master-data-sync/get_resource_validity_documents_v1_resources_resource__resource_id__validity__id__documents_get","metadata":{"seo":{"title":"Get Resource Validity Documents","description":"Fetch all documents associated with a specific resource validity."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get_resource_validity_documents_v1_resources_resource__resource_id__validity__id__documents_get","name":"Get Resource Validity Documents","isWebhook":false,"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1validity~1{id}~1documents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Resource Validity Documents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetch all documents associated with a specific resource validity."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"resource_id","in":"path","schemaId":"schema_144","required":true},{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1validity~1{id}~1documents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/resources/resource/{resource_id}/validity/{id}/documents","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"resource_id","in":"path","required":true,"schemaId":"schema_144"},{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/resources/resource/{resource_id}/validity/{id}/documents","href":"use-case-master-data-sync/get_resource_validity_documents_v1_resources_resource__resource_id__validity__id__documents_get","openApiOperationId":"Get_resource_validity_documents_v1_resources_resource__resource_id__validity__id__documents_get","summary":"Get Resource Validity Documents"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_149"}},"schemaId":"schema_149"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1validity~1{id}~1documents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_149","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_149"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-master-data-sync/get_resource_validity_documents_v1_resources_resource__resource_id__validity__id__documents_get"}],"panels":[]}]},"httpPath":"/v1/resources/resource/{resource_id}/validity/{id}/documents"},{"label":"List Resource Groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-master-data-sync/list_resource_groups_v1_resources_resource_groups_get","routeSlug":"/docs/use-case-master-data-sync/list_resource_groups_v1_resources_resource_groups_get","metadata":{"seo":{"title":"List Resource Groups","description":"List the resource groups resources can be allocated to. Archived resource groups are not included."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"List_resource_groups_v1_resources_resource_groups_get","name":"List Resource Groups","isWebhook":false,"pointer":"/paths/~1v1~1resources~1resource_groups/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Resource Groups","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List the resource groups resources can be allocated to. Archived resource groups are not included."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_89","description":"Pagination cursor. Mutually exclusive with other query parameters"},{"name":"code","in":"query","schemaId":"schema_92","description":"Resource group code to match exactly."},{"name":"code:in","in":"query","schemaId":"schema_93","description":"Resource group codes to match. Comma-separated list."}],"pointer":"/paths/~1v1~1resources~1resource_groups/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/resources/resource_groups","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_89"},{"name":"code","in":"query","required":false,"schemaId":"schema_92"},{"name":"code:in","in":"query","required":false,"schemaId":"schema_93"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/resources/resource_groups","href":"use-case-master-data-sync/list_resource_groups_v1_resources_resource_groups_get","openApiOperationId":"List_resource_groups_v1_resources_resource_groups_get","summary":"List Resource Groups"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListResourceGroupOutput"}},"schemaId":"components/schemas/ListResourceGroupOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1resources~1resource_groups/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListResourceGroupOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListResourceGroupOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-master-data-sync/list_resource_groups_v1_resources_resource_groups_get"}],"panels":[]}]},"httpPath":"/v1/resources/resource_groups"}],"content":{"contentType":"group","meta":{"name":"Use case / Master data sync"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Use case / Master data sync","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":"Required api role: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"API_MASTER_DATA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"API_ACCOUNTING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for company sync only."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/accounting/accounts","summary":"List Accounts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-master-data-sync/list_accounts_v1_accounting_accounts_get","deprecated":false},{"title":"/v1/accounting/exchange-rate","summary":"Create An Exchange Rate","prefix":{"name":"post","color":"post"},"badges":[],"link":"/use-case-master-data-sync/create_an_exchange_rate_v1_accounting_exchange_rate_post","deprecated":false},{"title":"/v1/accounting/exchange-rate","summary":"List Exchange Rates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-master-data-sync/list_exchange_rates_v1_accounting_exchange_rate_get","deprecated":false},{"title":"/v1/accounting/tax-rates","summary":"List Tax Rates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-master-data-sync/list_tax_rates_v1_accounting_tax_rates_get","deprecated":false},{"title":"/v1/documents/document/{id}/download","summary":"Download Document","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-master-data-sync/download_document_v1_documents_document__id__download_get","deprecated":false},{"title":"/v1/companies/company","summary":"List Companies","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-master-data-sync/list_companies_v1_companies_company_get","deprecated":false},{"title":"/v1/companies/company","summary":"Create Company","prefix":{"name":"post","color":"post"},"badges":[],"link":"/use-case-master-data-sync/create_company_v1_companies_company_post","deprecated":false},{"title":"/v1/companies/company/{company_id}/documents","summary":"Get Company Documents","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-master-data-sync/get_company_documents_v1_companies_company__company_id__documents_get","deprecated":false},{"title":"/v1/companies/company/{company_id}/documents","summary":"Create Company Document","prefix":{"name":"post","color":"post"},"badges":[],"link":"/use-case-master-data-sync/create_company_document_v1_companies_company__company_id__documents_post","deprecated":false},{"title":"/v1/companies/company/{company_id}/validity","summary":"List Company Validities","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-master-data-sync/list_company_validities_v1_companies_company__company_id__validity_get","deprecated":false},{"title":"/v1/companies/company/{company_id}/validity","summary":"Create Company Validity Request","prefix":{"name":"post","color":"post"},"badges":[],"link":"/use-case-master-data-sync/create_company_validity_request_v1_companies_company__company_id__validity_post","deprecated":false},{"title":"/v1/companies/company/{company_id}/validity/{id}","summary":"Get Company Validity","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-master-data-sync/get_company_validity_v1_companies_company__company_id__validity__id__get","deprecated":false},{"title":"/v1/companies/company/{company_id}/validity/{id}","summary":"Update Company Validity","prefix":{"name":"put","color":"put"},"badges":[],"link":"/use-case-master-data-sync/update_company_validity_v1_companies_company__company_id__validity__id__put","deprecated":false},{"title":"/v1/companies/company/{company_id}/validity/{id}","summary":"Delete Company Validity","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/use-case-master-data-sync/delete_company_validity_v1_companies_company__company_id__validity__id__delete","deprecated":false},{"title":"/v1/companies/company/{company_id}/validity/{id}/documents","summary":"Get Company Validity Documents","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-master-data-sync/get_company_validity_documents_v1_companies_company__company_id__validity__id__documents_get","deprecated":false},{"title":"/v1/companies/company/{id}","summary":"Get Company","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-master-data-sync/get_company_v1_companies_company__id__get","deprecated":false},{"title":"/v1/companies/company/{id}","summary":"Update Company","prefix":{"name":"put","color":"put"},"badges":[],"link":"/use-case-master-data-sync/update_company_v1_companies_company__id__put","deprecated":false},{"title":"/v1/companies/company/{id}","summary":"Update Company","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/use-case-master-data-sync/update_company_v1_companies_company__id__patch","deprecated":false},{"title":"/v1/companies/company/{id}","summary":"Archive Company","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/use-case-master-data-sync/archive_company_v1_companies_company__id__delete","deprecated":false},{"title":"/v1/locations/location","summary":"Create Location","prefix":{"name":"post","color":"post"},"badges":[],"link":"/use-case-master-data-sync/create_location_v1_locations_location_post","deprecated":false},{"title":"/v1/locations/location","summary":"List Locations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-master-data-sync/list_locations_v1_locations_location_get","deprecated":false},{"title":"/v1/locations/location/{location_id}","summary":"Update Location","prefix":{"name":"put","color":"put"},"badges":[],"link":"/use-case-master-data-sync/update_location_v1_locations_location__location_id__put","deprecated":false},{"title":"/v1/locations/location/{location_id}","summary":"Patch Location","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/use-case-master-data-sync/patch_location_v1_locations_location__location_id__patch","deprecated":false},{"title":"/v1/locations/location/{location_id}","summary":"Get Location","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-master-data-sync/get_location_v1_locations_location__location_id__get","deprecated":false},{"title":"/v1/resources/resource","summary":"Create Resource","prefix":{"name":"post","color":"post"},"badges":[],"link":"/use-case-master-data-sync/create_resource_v1_resources_resource_post","deprecated":false},{"title":"/v1/resources/resource","summary":"List Resources","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-master-data-sync/list_resources_v1_resources_resource_get","deprecated":false},{"title":"/v1/resources/resource/{resource_id}","summary":"Update Resource","prefix":{"name":"put","color":"put"},"badges":[],"link":"/use-case-master-data-sync/update_resource_v1_resources_resource__resource_id__put","deprecated":false},{"title":"/v1/resources/resource/{resource_id}","summary":"Patch Resource","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/use-case-master-data-sync/patch_resource_v1_resources_resource__resource_id__patch","deprecated":false},{"title":"/v1/resources/resource/{resource_id}","summary":"Archive Resource","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/use-case-master-data-sync/archive_resource_v1_resources_resource__resource_id__delete","deprecated":false},{"title":"/v1/resources/resource/{resource_id}","summary":"Get Resource","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-master-data-sync/get_resource_v1_resources_resource__resource_id__get","deprecated":false},{"title":"/v1/resources/resource/{resource_id}/unavailability","summary":"List Resource Unavailabilities","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-master-data-sync/list_resource_unavailabilities_v1_resources_resource__resource_id__unavailability_get","deprecated":false},{"title":"/v1/resources/resource/{resource_id}/unavailability","summary":"Create Resource Unavailabilities","prefix":{"name":"post","color":"post"},"badges":[],"link":"/use-case-master-data-sync/create_resource_unavailabilities_v1_resources_resource__resource_id__unavailability_post","deprecated":false},{"title":"/v1/resources/resource/{resource_id}/unavailability/{id}","summary":"Get Resource Unavailability","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-master-data-sync/get_resource_unavailability_v1_resources_resource__resource_id__unavailability__id__get","deprecated":false},{"title":"/v1/resources/resource/{resource_id}/unavailability/{id}","summary":"Update Resource Unavailabilities","prefix":{"name":"put","color":"put"},"badges":[],"link":"/use-case-master-data-sync/update_resource_unavailabilities_v1_resources_resource__resource_id__unavailability__id__put","deprecated":false},{"title":"/v1/resources/resource/{resource_id}/unavailability/{id}","summary":"Delete Resource Unavailabilities","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/use-case-master-data-sync/delete_resource_unavailabilities_v1_resources_resource__resource_id__unavailability__id__delete","deprecated":false},{"title":"/v1/resources/resource/{resource_id}/validity","summary":"List Resource Validities","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-master-data-sync/list_resource_validities_v1_resources_resource__resource_id__validity_get","deprecated":false},{"title":"/v1/resources/resource/{resource_id}/validity","summary":"Create Resource Validity Request","prefix":{"name":"post","color":"post"},"badges":[],"link":"/use-case-master-data-sync/create_resource_validity_request_v1_resources_resource__resource_id__validity_post","deprecated":false},{"title":"/v1/resources/resource/{resource_id}/validity/{id}","summary":"Get Resource Validity","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-master-data-sync/get_resource_validity_v1_resources_resource__resource_id__validity__id__get","deprecated":false},{"title":"/v1/resources/resource/{resource_id}/validity/{id}","summary":"Update Resource Validity","prefix":{"name":"put","color":"put"},"badges":[],"link":"/use-case-master-data-sync/update_resource_validity_v1_resources_resource__resource_id__validity__id__put","deprecated":false},{"title":"/v1/resources/resource/{resource_id}/validity/{id}","summary":"Delete Resource Validity","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/use-case-master-data-sync/delete_resource_validity_v1_resources_resource__resource_id__validity__id__delete","deprecated":false},{"title":"/v1/resources/resource/{resource_id}/validity/{id}/documents","summary":"Get Resource Validity Documents","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-master-data-sync/get_resource_validity_documents_v1_resources_resource__resource_id__validity__id__documents_get","deprecated":false},{"title":"/v1/resources/resource_groups","summary":"List Resource Groups","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-master-data-sync/list_resource_groups_v1_resources_resource_groups_get","deprecated":false}]}]}]}]}},{"type":"group","label":"Use case / Order","link":"/docs/use-case-order","routeSlug":"/docs/use-case-order","items":[{"type":"link","label":"Getting started","link":"/docs/use-case-order/getting-started","routeSlug":"/docs/use-case-order/getting-started","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Getting started"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"use-case-order/getting-started"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Getting started"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/section/transport-order-creation-and-status"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get started."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Customer portal","link":"/docs/use-case-order/customer-portal","routeSlug":"/docs/use-case-order/customer-portal","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Customer portal"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"use-case-order/customer-portal"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/use-case-customer-portal"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the customer version."},"children":[]}]}]}]}],"panels":[]}]}},{"label":"Download Document","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-order/download_document_v1_documents_document__id__download_get","routeSlug":"/docs/use-case-order/download_document_v1_documents_document__id__download_get","metadata":{"seo":{"title":"Download Document","description":"Download a document by its ID. You can choose to download the document directly or stream it."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"download_document_v1_documents_document__id__download_get","name":"Download Document","isWebhook":false,"pointer":"/paths/~1v1~1documents~1document~1{id}~1download/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download Document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Download a document by its ID. You can choose to download the document directly or stream it."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1documents~1document~1{id}~1download/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"direct","in":"query","schemaId":"schema_105","description":"Query parameter to indicate that the response should contain all the document bytes"}],"pointer":"/paths/~1v1~1documents~1document~1{id}~1download/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/documents/document/{id}/download","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[{"name":"direct","in":"query","required":false,"schemaId":"schema_105"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/documents/document/{id}/download","href":"use-case-order/download_document_v1_documents_document__id__download_get","openApiOperationId":"download_document_v1_documents_document__id__download_get","summary":"Download Document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}},"schemaId":"schema_106"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1documents~1document~1{id}~1download/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_106","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-order/download_document_v1_documents_document__id__download_get"}],"panels":[]}]},"httpPath":"/v1/documents/document/{id}/download"},{"label":"Import Order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-order/import_order_v1_orders_order_upload_post","routeSlug":"/docs/use-case-order/import_order_v1_orders_order_upload_post","metadata":{"seo":{"title":"Import Order","description":"Create or update orders in Qargo. See the \"Transport order creation & status\" section for more info."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"import_order_v1_orders_order_upload_post","name":"Import Order","isWebhook":false,"pointer":"/paths/~1v1~1orders~1order~1upload/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Import Order","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":"Create or update orders in Qargo. See the \"Transport order creation & status\" section for more info."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderInput"}},"schemaId":"components/schemas/OrderInput","pointer":"/paths/~1v1~1orders~1order~1upload/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/orders/order/upload","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrderInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/orders/order/upload","href":"use-case-order/import_order_v1_orders_order_upload_post","openApiOperationId":"import_order_v1_orders_order_upload_post","summary":"Import Order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/OrderInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderImport"}},"schemaId":"components/schemas/OrderImport"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1orders~1order~1upload/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderImport","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderImport"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-order/import_order_v1_orders_order_upload_post"}],"panels":[]}]},"httpPath":"/v1/orders/order/upload"},{"label":"Get Order Import Status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-order/get_order_import_status_v1_orders_order_upload__upload_id__get","routeSlug":"/docs/use-case-order/get_order_import_status_v1_orders_order_upload__upload_id__get","metadata":{"seo":{"title":"Get Order Import Status","description":"Get the status of an order import"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_order_import_status_v1_orders_order_upload__upload_id__get","name":"Get Order Import Status","isWebhook":false,"pointer":"/paths/~1v1~1orders~1order~1upload~1{upload_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Order Import Status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the status of an order import"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"upload_id","in":"path","schemaId":"schema_114","required":true}],"pointer":"/paths/~1v1~1orders~1order~1upload~1{upload_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/orders/order/upload/{upload_id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"upload_id","in":"path","required":true,"schemaId":"schema_114"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/orders/order/upload/{upload_id}","href":"use-case-order/get_order_import_status_v1_orders_order_upload__upload_id__get","openApiOperationId":"get_order_import_status_v1_orders_order_upload__upload_id__get","summary":"Get Order Import Status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderImport"}},"schemaId":"components/schemas/OrderImport"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1orders~1order~1upload~1{upload_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderImport","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderImport"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-order/get_order_import_status_v1_orders_order_upload__upload_id__get"}],"panels":[]}]},"httpPath":"/v1/orders/order/upload/{upload_id}"},{"label":"Get Order Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-order/get_order_details_v1_orders_order__order_id__get","routeSlug":"/docs/use-case-order/get_order_details_v1_orders_order__order_id__get","metadata":{"seo":{"title":"Get Order Details","description":"Fetch order detail"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_order_details_v1_orders_order__order_id__get","name":"Get Order Details","isWebhook":false,"pointer":"/paths/~1v1~1orders~1order~1{order_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Order Details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetch order detail"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"order_id","in":"path","schemaId":"schema_115","required":true}],"pointer":"/paths/~1v1~1orders~1order~1{order_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/orders/order/{order_id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"order_id","in":"path","required":true,"schemaId":"schema_115"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/orders/order/{order_id}","href":"use-case-order/get_order_details_v1_orders_order__order_id__get","openApiOperationId":"get_order_details_v1_orders_order__order_id__get","summary":"Get Order Details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderDetailOutput"}},"schemaId":"components/schemas/OrderDetailOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1orders~1order~1{order_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderDetailOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderDetailOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-order/get_order_details_v1_orders_order__order_id__get"}],"panels":[]}]},"httpPath":"/v1/orders/order/{order_id}"},{"label":"List Order Charges","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-order/list_order_charges_v1_orders_order__order_id__charges_get","routeSlug":"/docs/use-case-order/list_order_charges_v1_orders_order__order_id__charges_get","metadata":{"seo":{"title":"List Order Charges","description":"Charges for a certain order. Note that these charges are not final and may change"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"List_Order_Charges_v1_orders_order__order_id__charges_get","name":"List Order Charges","isWebhook":false,"pointer":"/paths/~1v1~1orders~1order~1{order_id}~1charges/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Order Charges","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Charges for a certain order. Note that these charges are not final and may change"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"order_id","in":"path","schemaId":"schema_115","required":true}],"pointer":"/paths/~1v1~1orders~1order~1{order_id}~1charges/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/orders/order/{order_id}/charges","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"order_id","in":"path","required":true,"schemaId":"schema_115"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/orders/order/{order_id}/charges","href":"use-case-order/list_order_charges_v1_orders_order__order_id__charges_get","openApiOperationId":"List_Order_Charges_v1_orders_order__order_id__charges_get","summary":"List Order Charges"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderChargesOutput"}},"schemaId":"components/schemas/OrderChargesOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1orders~1order~1{order_id}~1charges/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderChargesOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderChargesOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-order/list_order_charges_v1_orders_order__order_id__charges_get"}],"panels":[]}]},"httpPath":"/v1/orders/order/{order_id}/charges"},{"label":"Approve Order Charges","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-order/approve_order_charges_v1_orders_order__order_id__charges_approval_post","routeSlug":"/docs/use-case-order/approve_order_charges_v1_orders_order__order_id__charges_approval_post","metadata":{"seo":{"title":"Approve Order Charges","description":"Approve or reject certain charges on the order"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Approve_Order_Charges_v1_orders_order__order_id__charges_approval_post","name":"Approve Order Charges","isWebhook":false,"pointer":"/paths/~1v1~1orders~1order~1{order_id}~1charges~1approval/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Approve Order Charges","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Approve or reject certain charges on the order"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"order_id","in":"path","schemaId":"schema_115","required":true}],"pointer":"/paths/~1v1~1orders~1order~1{order_id}~1charges~1approval/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ChargesApprovalInput"}},"schemaId":"components/schemas/ChargesApprovalInput","pointer":"/paths/~1v1~1orders~1order~1{order_id}~1charges~1approval/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/orders/order/{order_id}/charges/approval","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"order_id","in":"path","required":true,"schemaId":"schema_115"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ChargesApprovalInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/orders/order/{order_id}/charges/approval","href":"use-case-order/approve_order_charges_v1_orders_order__order_id__charges_approval_post","openApiOperationId":"Approve_Order_Charges_v1_orders_order__order_id__charges_approval_post","summary":"Approve Order Charges"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/ChargesApprovalInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ChargesApprovalInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderChargesOutput"}},"schemaId":"components/schemas/OrderChargesOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1orders~1order~1{order_id}~1charges~1approval/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderChargesOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderChargesOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-order/approve_order_charges_v1_orders_order__order_id__charges_approval_post"}],"panels":[]}]},"httpPath":"/v1/orders/order/{order_id}/charges/approval"},{"label":"List Order Documents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-order/list_order_documents_v1_orders_order__order_id__documents_get","routeSlug":"/docs/use-case-order/list_order_documents_v1_orders_order__order_id__documents_get","metadata":{"seo":{"title":"List Order Documents","description":"Fetch documents for an order. This includes consignment documents"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_order_documents_v1_orders_order__order_id__documents_get","name":"List Order Documents","isWebhook":false,"pointer":"/paths/~1v1~1orders~1order~1{order_id}~1documents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Order Documents","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":"Fetch documents for an order. This includes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consignment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" documents"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"order_id","in":"path","schemaId":"schema_115","required":true}],"pointer":"/paths/~1v1~1orders~1order~1{order_id}~1documents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/orders/order/{order_id}/documents","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"order_id","in":"path","required":true,"schemaId":"schema_115"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/orders/order/{order_id}/documents","href":"use-case-order/list_order_documents_v1_orders_order__order_id__documents_get","openApiOperationId":"list_order_documents_v1_orders_order__order_id__documents_get","summary":"List Order Documents"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_116"}},"schemaId":"schema_116"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1orders~1order~1{order_id}~1documents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_116","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_116"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-order/list_order_documents_v1_orders_order__order_id__documents_get"}],"panels":[]}]},"httpPath":"/v1/orders/order/{order_id}/documents"},{"label":"Order Export","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-order/order_export_v1_orders_order__order_id__export_get","routeSlug":"/docs/use-case-order/order_export_v1_orders_order__order_id__export_get","metadata":{"seo":{"title":"Order Export","description":"Provides a minimal set of order data that can be used as a blueprint to create a new order"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"order_export_v1_orders_order__order_id__export_get","name":"Order Export","isWebhook":false,"pointer":"/paths/~1v1~1orders~1order~1{order_id}~1export/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order Export","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Provides a minimal set of order data that can be used as a blueprint to create a new order"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"order_id","in":"path","schemaId":"schema_115","required":true}],"pointer":"/paths/~1v1~1orders~1order~1{order_id}~1export/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/orders/order/{order_id}/export","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"order_id","in":"path","required":true,"schemaId":"schema_115"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/orders/order/{order_id}/export","href":"use-case-order/order_export_v1_orders_order__order_id__export_get","openApiOperationId":"order_export_v1_orders_order__order_id__export_get","summary":"Order Export"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderExport"}},"schemaId":"components/schemas/OrderExport"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1orders~1order~1{order_id}~1export/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderExport","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderExport"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-order/order_export_v1_orders_order__order_id__export_get"}],"panels":[]}]},"httpPath":"/v1/orders/order/{order_id}/export"},{"label":"Order Status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-order/order_status_v1_orders_order__order_id__status_get","routeSlug":"/docs/use-case-order/order_status_v1_orders_order__order_id__status_get","metadata":{"seo":{"title":"Order Status","description":"Order status endpoint. Provides information on the status of the order"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"order_status_v1_orders_order__order_id__status_get","name":"Order Status","isWebhook":false,"pointer":"/paths/~1v1~1orders~1order~1{order_id}~1status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order Status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Order status endpoint. Provides information on the status of the order"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"order_id","in":"path","schemaId":"schema_115","required":true}],"pointer":"/paths/~1v1~1orders~1order~1{order_id}~1status/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/orders/order/{order_id}/status","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"order_id","in":"path","required":true,"schemaId":"schema_115"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/orders/order/{order_id}/status","href":"use-case-order/order_status_v1_orders_order__order_id__status_get","openApiOperationId":"order_status_v1_orders_order__order_id__status_get","summary":"Order Status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderWithStatus"}},"schemaId":"components/schemas/OrderWithStatus"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1orders~1order~1{order_id}~1status/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderWithStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderWithStatus"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-order/order_status_v1_orders_order__order_id__status_get"}],"panels":[]}]},"httpPath":"/v1/orders/order/{order_id}/status"},{"label":"Operational Visibility Event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-order/operational_visibility_event_webhook_post","routeSlug":"/docs/use-case-order/operational_visibility_event_webhook_post","metadata":{"seo":{"title":"Operational Visibility Event","description":"Webhook for updates to orders and trips. Subscribe to this endpoint to receive updates."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"operational_visibility_event_webhook_post","name":"Operational Visibility Event","isWebhook":false,"pointer":"/paths/https:~1~1<visibility-event-receiving-endpoint>/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Operational Visibility Event","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":"Webhook for updates to orders and trips. Subscribe to this endpoint to receive updates."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, Qargo sends payloads using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OperationalVisibilityUpdate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" schema:"},"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":"code","inline":true,"attributes":{"content":"order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OrderUpdate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"StopUpdate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DocumentUpdate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EtaUpdate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HandlingUnitUpdate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" events."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OrderImportUpdate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and other events not listed above may not include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not populated"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"by default; including it requires a custom webhook format configured by Qargo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom webhook format configured by Qargo may use a different structure."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_117"}},"schemaId":"schema_117","pointer":"/paths/https:~1~1<visibility-event-receiving-endpoint>/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"https://<visibility-event-receiving-endpoint>","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_117"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"https://<visibility-event-receiving-endpoint>","href":"use-case-order/operational_visibility_event_webhook_post","openApiOperationId":"operational_visibility_event_webhook_post","summary":"Operational Visibility Event"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"schema_117","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_117"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}},"schemaId":"schema_106"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/https:~1~1<visibility-event-receiving-endpoint>/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_106","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-order/operational_visibility_event_webhook_post"}],"panels":[]}]},"httpPath":"https://<visibility-event-receiving-endpoint>"},{"label":"Create/Update/Cancel Orders","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-order/order-import-webhook","routeSlug":"/docs/use-case-order/order-import-webhook","metadata":{"seo":{"title":"Create/Update/Cancel Orders","description":"Webhook for creating/updating and cancelling transport orders."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"order-import-webhook","name":"Create/Update/Cancel Orders","isWebhook":false,"pointer":"/paths/~1v1~1webhook/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create/Update/Cancel Orders","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":"Webhook for creating/updating and cancelling transport orders."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the fully asynchronous version of the order upload api."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The documented schema is our default input format, but we can also map custom formats."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that this webhook uses Basic Auth instead of the OAuth credentials used for the api."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please contact integrations@qargo.com to request credentials."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuthWebhookCredentials","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_150"}},"schemaId":"schema_150","pointer":"/paths/~1v1~1webhook/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/webhook","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuthWebhookCredentials","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_150"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/webhook","href":"use-case-order/order-import-webhook","openApiOperationId":"order-import-webhook","summary":"Create/Update/Cancel Orders"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"schema_150","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_150"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_151"}},"schemaId":"schema_151"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1webhook/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_151","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_151"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-order/order-import-webhook"}],"panels":[]}]},"httpPath":"/v1/webhook"},{"label":"Partial Order Update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-order/partial-order-update","routeSlug":"/docs/use-case-order/partial-order-update","metadata":{"seo":{"title":"Partial Order Update","description":"Webhook for partial order updates. Push to the endpoint to update specific fields of an existing order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"partial-order-update","name":"Partial Order Update","isWebhook":false,"pointer":"/paths/~1v1~1webhook~1partial-order-update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partial Order Update","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Webhook for partial order updates. Push to the endpoint to update specific fields of an existing order."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuthWebhookCredentials","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderUpdatePayload"}},"schemaId":"components/schemas/OrderUpdatePayload","pointer":"/paths/~1v1~1webhook~1partial-order-update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/webhook/partial-order-update","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuthWebhookCredentials","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrderUpdatePayload"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/webhook/partial-order-update","href":"use-case-order/partial-order-update","openApiOperationId":"partial-order-update","summary":"Partial Order Update"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/OrderUpdatePayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderUpdatePayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_152"}},"schemaId":"schema_152"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1webhook~1partial-order-update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_152","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_152"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-order/partial-order-update"}],"panels":[]}]},"httpPath":"/v1/webhook/partial-order-update"}],"content":{"contentType":"group","meta":{"name":"Use case / Order"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Use case / 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":"Required api role: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"API_ORDER"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All endpoints related to order creation and status retrieval/subscription."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/documents/document/{id}/download","summary":"Download Document","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-order/download_document_v1_documents_document__id__download_get","deprecated":false},{"title":"/v1/orders/order/upload","summary":"Import Order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/use-case-order/import_order_v1_orders_order_upload_post","deprecated":false},{"title":"/v1/orders/order/upload/{upload_id}","summary":"Get Order Import Status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-order/get_order_import_status_v1_orders_order_upload__upload_id__get","deprecated":false},{"title":"/v1/orders/order/{order_id}","summary":"Get Order Details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-order/get_order_details_v1_orders_order__order_id__get","deprecated":false},{"title":"/v1/orders/order/{order_id}/charges","summary":"List Order Charges","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-order/list_order_charges_v1_orders_order__order_id__charges_get","deprecated":false},{"title":"/v1/orders/order/{order_id}/charges/approval","summary":"Approve Order Charges","prefix":{"name":"post","color":"post"},"badges":[],"link":"/use-case-order/approve_order_charges_v1_orders_order__order_id__charges_approval_post","deprecated":false},{"title":"/v1/orders/order/{order_id}/documents","summary":"List Order Documents","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-order/list_order_documents_v1_orders_order__order_id__documents_get","deprecated":false},{"title":"/v1/orders/order/{order_id}/export","summary":"Order Export","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-order/order_export_v1_orders_order__order_id__export_get","deprecated":false},{"title":"/v1/orders/order/{order_id}/status","summary":"Order Status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/use-case-order/order_status_v1_orders_order__order_id__status_get","deprecated":false},{"title":"https://<visibility-event-receiving-endpoint>","summary":"Operational Visibility Event","prefix":{"name":"post","color":"post"},"badges":[],"link":"/use-case-order/operational_visibility_event_webhook_post","deprecated":false},{"title":"/v1/webhook","summary":"Create/Update/Cancel Orders","prefix":{"name":"post","color":"post"},"badges":[],"link":"/use-case-order/order-import-webhook","deprecated":false},{"title":"/v1/webhook/partial-order-update","summary":"Partial Order Update","prefix":{"name":"post","color":"post"},"badges":[],"link":"/use-case-order/partial-order-update","deprecated":false}]}]}]}]}},{"type":"group","label":"Use case / Subcontractor dispatch","link":"/docs/use-case-subcontractor-dispatch","routeSlug":"/docs/use-case-subcontractor-dispatch","items":[{"label":"External Document Update With Payload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-subcontractor-dispatch/subcontractor-document-upload-webhook","routeSlug":"/docs/use-case-subcontractor-dispatch/subcontractor-document-upload-webhook","metadata":{"seo":{"title":"External Document Update With Payload","description":"Upload a document to a specific stop on a subcontracted trip."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"subcontractor-document-upload-webhook","name":"External Document Update With Payload","isWebhook":false,"pointer":"/paths/~1v1~1webhook~1subco-document-upload/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"External Document Update With Payload","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":"Upload a document to a specific stop on a subcontracted trip."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This webhook uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Basic Auth"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (webhook credentials), not the OAuth credentials used for the API."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact integrations@qargo.com to request credentials."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/subcontractor-document-upload-webhook/request/use-case-subcontractor-dispatch/subcontractor-document-upload-webhook/request/use-case-document-import/subcontractor-document-upload-webhook/request/query-parameters","deepLinkHash":"/webhooks-inbound/subcontractor-document-upload-webhook#webhooks-inbound/subcontractor-document-upload-webhook/request/use-case-subcontractor-dispatch/subcontractor-document-upload-webhook/request/use-case-document-import/subcontractor-document-upload-webhook/request/query-parameters"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query parameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"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":"code","inline":true,"attributes":{"content":"question_path_key"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maps the file to a document type in Qargo (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CMR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WEIGHT_NOTE"},"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":"code","inline":true,"attributes":{"content":"stop_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Qargo UUID of the stop to attach the document to"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/subcontractor-document-upload-webhook/request/use-case-subcontractor-dispatch/subcontractor-document-upload-webhook/request/use-case-document-import/subcontractor-document-upload-webhook/request/headers","deepLinkHash":"/webhooks-inbound/subcontractor-document-upload-webhook#webhooks-inbound/subcontractor-document-upload-webhook/request/use-case-subcontractor-dispatch/subcontractor-document-upload-webhook/request/use-case-document-import/subcontractor-document-upload-webhook/request/headers"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Headers"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Header"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"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":"code","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":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MIME type of the file (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/jpeg"},"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":"code","inline":true,"attributes":{"content":"Content-Disposition"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provides the filename: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachment; filename=\"POD.pdf\""},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/subcontractor-document-upload-webhook/request/use-case-subcontractor-dispatch/subcontractor-document-upload-webhook/request/use-case-document-import/subcontractor-document-upload-webhook/request/filename-handling","deepLinkHash":"/webhooks-inbound/subcontractor-document-upload-webhook#webhooks-inbound/subcontractor-document-upload-webhook/request/use-case-subcontractor-dispatch/subcontractor-document-upload-webhook/request/use-case-document-import/subcontractor-document-upload-webhook/request/filename-handling"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filename handling"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The uploaded file's name in Qargo is determined by:"},"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":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Disposition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" includes a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filename"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — that value is used, combined with the question path key default."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filename=\"pod1234.pdf\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with question path key default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POD.pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → stored as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pod1234_POD.pdf"},"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":"If no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Disposition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided — the default filename from the question path key configuration is used."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/subcontractor-document-upload-webhook/request/use-case-subcontractor-dispatch/subcontractor-document-upload-webhook/request/use-case-document-import/subcontractor-document-upload-webhook/request/example","deepLinkHash":"/webhooks-inbound/subcontractor-document-upload-webhook#webhooks-inbound/subcontractor-document-upload-webhook/request/use-case-subcontractor-dispatch/subcontractor-document-upload-webhook/request/use-case-document-import/subcontractor-document-upload-webhook/request/example"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -X POST \\\n  \"https://api.qargo.com/v1/webhook/subco-document-upload\\\n  ?question_path_key=POD&stop_id=<stop_uuid>\" \\\n  -u \"<webhook_client_id>:<webhook_secret_id>\" \\\n  -H \"Content-Type: application/pdf\" \\\n  -H \"Content-Disposition: attachment; filename=POD.pdf\" \\\n  --data-binary @/path/to/document.pdf\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -X POST \\\n  \"https://api.qargo.com/v1/webhook/subco-document-upload\\\n  ?question_path_key=POD&stop_id=<stop_uuid>\" \\\n  -u \"<webhook_client_id>:<webhook_secret_id>\" \\\n  -H \"Content-Type: application/pdf\" \\\n  -H \"Content-Disposition: attachment; filename=POD.pdf\" \\\n  --data-binary @/path/to/document.pdf\n"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuthWebhookCredentials","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"question_path_key","in":"query","schemaId":"schema_120","description":"The question path key to map the file in Qargo, for example: CMR/POD","required":true},{"name":"stop_id","in":"query","schemaId":"schema_124","description":"The stop ID to which the document is related","required":true}],"pointer":"/paths/~1v1~1webhook~1subco-document-upload/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_123"}},"schemaId":"schema_123","pointer":"/paths/~1v1~1webhook~1subco-document-upload/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/webhook/subco-document-upload","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[{"name":"question_path_key","in":"query","required":true,"schemaId":"schema_120"},{"name":"stop_id","in":"query","required":true,"schemaId":"schema_124"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuthWebhookCredentials","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_123"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/webhook/subco-document-upload","href":"use-case-subcontractor-dispatch/subcontractor-document-upload-webhook","openApiOperationId":"subcontractor-document-upload-webhook","summary":"External Document Update With Payload"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"schema_123","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_123"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}},"schemaId":"schema_106"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1webhook~1subco-document-upload/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_106","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-subcontractor-dispatch/subcontractor-document-upload-webhook"}],"panels":[]}]},"httpPath":"/v1/webhook/subco-document-upload"},{"label":"External Status Update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-subcontractor-dispatch/subcontractor-status-update-webhook","routeSlug":"/docs/use-case-subcontractor-dispatch/subcontractor-status-update-webhook","metadata":{"seo":{"title":"External Status Update","description":"Webhook for updating the status, ETA, and data of stops from an external subcontractor system."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"subcontractor-status-update-webhook","name":"External Status Update","isWebhook":false,"pointer":"/paths/~1v1~1webhook~1subco-status-update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"External Status Update","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":"Webhook for updating the status, ETA, and data of stops from an external subcontractor system."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that this webhook uses Basic Auth instead of the OAuth credentials used for the api."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please contact integrations@qargo.com to request credentials."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eta_start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eta_end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" date-time values must include a timezone offset,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2025-06-15T10:30:00Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2025-06-15T12:30:00+02:00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/subcontractor-status-update-webhook/request/use-case-subcontractor-dispatch/subcontractor-status-update-webhook/request/identifying-a-stop","deepLinkHash":"/webhooks-inbound/subcontractor-status-update-webhook#webhooks-inbound/subcontractor-status-update-webhook/request/use-case-subcontractor-dispatch/subcontractor-status-update-webhook/request/identifying-a-stop"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifying a stop"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each update targets a single stop. You can identify it by its Qargo UUID or by matching criteria."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"webhooks-inbound/subcontractor-status-update-webhook/request/use-case-subcontractor-dispatch/subcontractor-status-update-webhook/request/by-stop-id-(preferred)","deepLinkHash":"/webhooks-inbound/subcontractor-status-update-webhook#webhooks-inbound/subcontractor-status-update-webhook/request/use-case-subcontractor-dispatch/subcontractor-status-update-webhook/request/by-stop-id-(preferred)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By stop ID (preferred)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you know the Qargo stop UUID, pass it directly in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"updates\": [\n    {\n      \"stop\": { \"id\": \"a1b2c3d4-0000-0000-0000-000000000000\", \"status\": \"AT_STOP\" },\n      \"event_time\": \"2025-06-15T10:30:00Z\"\n    }\n  ]\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"updates\": [\n    {\n      \"stop\": { \"id\": \"a1b2c3d4-0000-0000-0000-000000000000\", \"status\": \"AT_STOP\" },\n      \"event_time\": \"2025-06-15T10:30:00Z\"\n    }\n  ]\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"webhooks-inbound/subcontractor-status-update-webhook/request/use-case-subcontractor-dispatch/subcontractor-status-update-webhook/request/by-matching-criteria","deepLinkHash":"/webhooks-inbound/subcontractor-status-update-webhook#webhooks-inbound/subcontractor-status-update-webhook/request/use-case-subcontractor-dispatch/subcontractor-status-update-webhook/request/by-matching-criteria"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By matching criteria"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the stop ID is not known, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop.match"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to find the stop by its related entities."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The matcher uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all provided criteria combined"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (AND logic) and expects "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"exactly one stop"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to match. If zero or multiple stops match, the update is discarded."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available matching fields:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"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":"code","inline":true,"attributes":{"content":"trip"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name.matches_any"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trip name(s)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name.matches_any"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order name(s)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer_reference_number.matches_any"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer reference number(s)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id.matches_any"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order UUID(s)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consignment"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference_number.matches_any"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Consignment reference number(s)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consignment"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order_sequence_number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Consignment sequence number within the order (integer)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference_number.matches_any"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stop reference number(s)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop_type"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PICKUP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELIVERY"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"matches_any"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field accepts a list of values — the stop matches if its value equals "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"any"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of them."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When multiple fields are provided, they are all required to match (AND)."},"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":"Example — match by order reference + stop type:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"updates\": [\n    {\n      \"stop\": {\n        \"match\": {\n          \"matches_all\": [\n            {\n              \"order\": { \"customer_reference_number\": { \"matches_any\": [\"REF-12345\"] } },\n              \"stop\": { \"stop_type\": \"DELIVERY\" }\n            }\n          ]\n        },\n        \"status\": \"COMPLETED\"\n      },\n      \"event_time\": \"2025-06-15T14:00:00Z\"\n    }\n  ]\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"updates\": [\n    {\n      \"stop\": {\n        \"match\": {\n          \"matches_all\": [\n            {\n              \"order\": { \"customer_reference_number\": { \"matches_any\": [\"REF-12345\"] } },\n              \"stop\": { \"stop_type\": \"DELIVERY\" }\n            }\n          ]\n        },\n        \"status\": \"COMPLETED\"\n      },\n      \"event_time\": \"2025-06-15T14:00:00Z\"\n    }\n  ]\n}\n"},"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":"Example — match by trip name + consignment reference:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"updates\": [\n    {\n      \"stop\": {\n        \"match\": {\n          \"matches_all\": [\n            {\n              \"trip\": { \"name\": { \"matches_any\": [\"T-20250615-001\"] } },\n              \"consignment\": { \"reference_number\": { \"matches_any\": [\"CONS-98765\"] } }\n            }\n          ]\n        },\n        \"status\": \"AT_STOP\",\n        \"eta_end\": \"2025-06-15T16:00:00Z\"\n      },\n      \"event_time\": \"2025-06-15T14:30:00Z\"\n    }\n  ]\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"updates\": [\n    {\n      \"stop\": {\n        \"match\": {\n          \"matches_all\": [\n            {\n              \"trip\": { \"name\": { \"matches_any\": [\"T-20250615-001\"] } },\n              \"consignment\": { \"reference_number\": { \"matches_any\": [\"CONS-98765\"] } }\n            }\n          ]\n        },\n        \"status\": \"AT_STOP\",\n        \"eta_end\": \"2025-06-15T16:00:00Z\"\n      },\n      \"event_time\": \"2025-06-15T14:30:00Z\"\n    }\n  ]\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/subcontractor-status-update-webhook/request/use-case-subcontractor-dispatch/subcontractor-status-update-webhook/request/statuses","deepLinkHash":"/webhooks-inbound/subcontractor-status-update-webhook#webhooks-inbound/subcontractor-status-update-webhook/request/use-case-subcontractor-dispatch/subcontractor-status-update-webhook/request/statuses"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statuses"},"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":"code","inline":true,"attributes":{"content":"AT_STOP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the vehicle has arrived at the stop location."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the stop activity is finished."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Omit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to update only the ETA or data fields without changing the stop status."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuthWebhookCredentials","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubcontractorStatusUpdatePayload"}},"schemaId":"components/schemas/SubcontractorStatusUpdatePayload","pointer":"/paths/~1v1~1webhook~1subco-status-update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/webhook/subco-status-update","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuthWebhookCredentials","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SubcontractorStatusUpdatePayload"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/webhook/subco-status-update","href":"use-case-subcontractor-dispatch/subcontractor-status-update-webhook","openApiOperationId":"subcontractor-status-update-webhook","summary":"External Status Update"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/SubcontractorStatusUpdatePayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubcontractorStatusUpdatePayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}},"schemaId":"schema_106"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1webhook~1subco-status-update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_106","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-subcontractor-dispatch/subcontractor-status-update-webhook"}],"panels":[]}]},"httpPath":"/v1/webhook/subco-status-update"},{"label":"Subcontractor Dispatch Payload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-subcontractor-dispatch/subcontractor-dispatch-payload","routeSlug":"/docs/use-case-subcontractor-dispatch/subcontractor-dispatch-payload","metadata":{"seo":{"title":"Subcontractor Dispatch Payload","description":"Payload for sending a trip dispatch.In this case, we send the payload to an external endpoint for processing."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"subcontractor-dispatch-payload","name":"Subcontractor Dispatch Payload","isWebhook":false,"pointer":"/paths/https:~1~1<external_subco_receiving_endpoint>/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subcontractor Dispatch Payload","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":"Payload for sending a trip dispatch."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In this case, we send the payload to an external endpoint for processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, we send our standard "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SubcontractorDispatch"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" schema,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"but the body can also be a custom mapped format."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_153"}},"schemaId":"schema_153","pointer":"/paths/https:~1~1<external_subco_receiving_endpoint>/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"https://<external_subco_receiving_endpoint>","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_153"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"https://<external_subco_receiving_endpoint>","href":"use-case-subcontractor-dispatch/subcontractor-dispatch-payload","openApiOperationId":"subcontractor-dispatch-payload","summary":"Subcontractor Dispatch Payload"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"schema_153","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_153"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_154"}},"schemaId":"schema_154"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/https:~1~1<external_subco_receiving_endpoint>/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_154","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_154"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-subcontractor-dispatch/subcontractor-dispatch-payload"}],"panels":[]}]},"httpPath":"https://<external_subco_receiving_endpoint>"}],"content":{"contentType":"group","meta":{"name":"Use case / Subcontractor dispatch"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Use case / Subcontractor dispatch","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":"Required api role: not applicable (push/push)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose: This interface allows an external party to integrate with 3rd party transport management systems for subcontracting."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The subcontractor dispatch uses a push/push model: Qargo pushes a dispatch payload to an external endpoint."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The third party then updates Qargo using our webhook endpoint:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"image","inline":true,"attributes":{"alt":"dispatch flow","src":"https://api.qargo.com/docs/static/subco_dispatch_flow.svg"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subsequent updates or cancellations will also be sent via this webhook, using the same payload format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The dispatch format has the following structure:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"image","inline":true,"attributes":{"alt":"dispatch payload","src":"https://api.qargo.com/docs/static/dispatch_subco_payload.svg"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The destination of this webhook can be a RESTful interface or file base protocol like SFTP"},"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":"link","inline":true,"attributes":{"href":"/docs/use-case-subcontractor-dispatch/subcontractor-status-update-webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status update endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be used to receive information about the stops back to Qargo."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status update date-time values, including "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eta_start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eta_end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", must include a timezone offset such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+02:00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/webhook/subco-document-upload","summary":"External Document Update With Payload","prefix":{"name":"post","color":"post"},"badges":[],"link":"/use-case-subcontractor-dispatch/subcontractor-document-upload-webhook","deprecated":false},{"title":"/v1/webhook/subco-status-update","summary":"External Status Update","prefix":{"name":"post","color":"post"},"badges":[],"link":"/use-case-subcontractor-dispatch/subcontractor-status-update-webhook","deprecated":false},{"title":"https://<external_subco_receiving_endpoint>","summary":"Subcontractor Dispatch Payload","prefix":{"name":"post","color":"post"},"badges":[],"link":"/use-case-subcontractor-dispatch/subcontractor-dispatch-payload","deprecated":false}]}]}]}]}},{"type":"group","label":"Use case / Tracking","link":"/docs/use-case-tracking","routeSlug":"/docs/use-case-tracking","items":[{"label":"Tracking Update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-tracking/tracking-update","routeSlug":"/docs/use-case-tracking/tracking-update","metadata":{"seo":{"title":"Tracking Update","description":"Webhook for tracking updates."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tracking-update","name":"Tracking Update","isWebhook":false,"pointer":"/paths/~1v1~1webhook~1tracking-update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tracking Update","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Webhook for tracking updates.\n\nPush to the endpoint to update tracking information for a resource."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuthWebhookCredentials","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TrackingUpdatePayload"}},"schemaId":"components/schemas/TrackingUpdatePayload","pointer":"/paths/~1v1~1webhook~1tracking-update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/webhook/tracking-update","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuthWebhookCredentials","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TrackingUpdatePayload"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/webhook/tracking-update","href":"use-case-tracking/tracking-update","openApiOperationId":"tracking-update","summary":"Tracking Update"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/TrackingUpdatePayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TrackingUpdatePayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_155"}},"schemaId":"schema_155"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1webhook~1tracking-update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_155","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_155"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-tracking/tracking-update"}],"panels":[]}]},"httpPath":"/v1/webhook/tracking-update"}],"content":{"contentType":"group","meta":{"name":"Use case / Tracking"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Use case / Tracking","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/webhook/tracking-update","summary":"Tracking Update","prefix":{"name":"post","color":"post"},"badges":[],"link":"/use-case-tracking/tracking-update","deprecated":false}]}]}]}]}},{"type":"group","label":"Use case / Trip import","link":"/docs/use-case-trip-import","routeSlug":"/docs/use-case-trip-import","items":[{"type":"link","label":"Getting started","link":"/docs/use-case-trip-import/getting-started","routeSlug":"/docs/use-case-trip-import/getting-started","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Getting started"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"use-case-trip-import/getting-started"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Getting started"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A trip import pushes stop sequences, resource assignments, and timing information into Qargo so that the planning board reflects the externally computed plan."},"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":"trip_identifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used to determine whether an incoming trip is new or an update to an existing one:"},"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":"Create"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — a new trip is created when a payload arrives with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trip_identifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that has not been seen before."},"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":"Update"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — if a payload arrives with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trip_identifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that already exists, Qargo updates the original trip rather than creating a new one."},"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":"Cancel"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status = 'CANCELLED'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will remove the trip. A trip must have been created before it can be cancelled."},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Limitations","link":"/docs/use-case-trip-import/limitations","routeSlug":"/docs/use-case-trip-import/limitations","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Limitations"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"use-case-trip-import/limitations"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limitations"},"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":"Stops must be referenced by their Qargo stop "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Location names, using location details or aliases are not supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each stop must have a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sequence"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value (starting from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and a start/end timestamp. Missing either will cause the import to fail."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resources can only be assigned by their Qargo resource "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — not by license plate, name, or external reference."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All stops in the payload must be unplanned. Stops that are already assigned to another trip cannot be imported."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trips are created automatically — there is no approval or review step before the trip appears on the planning board (unlike order import)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cancelled trip cannot receive further updates. To re-import, use a new "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trip_identifier"},"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":"Stop timestamps must be logically consistent: the sequence order must match the chronological order, and a delivery stop cannot precede its corresponding pickup."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trip import is asynchronous — the endpoint does not return trip data."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Splitting a trip into multiple trips is not supported via trip import - split the order first."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each integration instance supports either webhook or EDI routing — not both simultaneously."},"children":[]}]}]}]}]}],"panels":[]}]}},{"label":"Import Trip","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-trip-import/trip-import-webhook","routeSlug":"/docs/use-case-trip-import/trip-import-webhook","metadata":{"seo":{"title":"Import Trip","description":"Webhook for planning a list of stops on a trip and assigning resources."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"trip-import-webhook","name":"Import Trip","isWebhook":false,"pointer":"/paths/~1v1~1webhook~1trip-import/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Import Trip","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":"Webhook for planning a list of stops on a trip and assigning resources."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The documented schema is our default input format, but we can also map custom formats,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"keeping in mind the limitations that are documented under use cases."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that this webhook uses Basic Auth instead of the OAuth credentials used for the api."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please contact integrations@qargo.com to request credentials."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuthWebhookCredentials","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_156"}},"schemaId":"schema_156","pointer":"/paths/~1v1~1webhook~1trip-import/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/webhook/trip-import","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuthWebhookCredentials","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_156"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/webhook/trip-import","href":"use-case-trip-import/trip-import-webhook","openApiOperationId":"trip-import-webhook","summary":"Import Trip"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"schema_156","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_156"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_157"}},"schemaId":"schema_157"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1webhook~1trip-import/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_157","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_157"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-trip-import/trip-import-webhook"}],"panels":[]}]},"httpPath":"/v1/webhook/trip-import"}],"content":{"contentType":"group","meta":{"name":"Use case / Trip import"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Use case / Trip import","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":"Required api role: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"API_TRIP"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose: This interface allows an external system (e.g. a route optimisation tool) to send fully planned trips into Qargo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a trip payload arrives, Qargo creates or updates a trip with the specified stops, sequence, timestamps, and resource assignments — without manual planning."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The trip import is the last step of a larger planning flow:"},"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":"The external system obtains the Qargo "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"s of the stops and resources to plan. Qargo can push this planning data to the external system (an optional export, configured per integration), or the external system fetches it via the API (e.g. orders and resources)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The external system computes trips and assigns each one a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trip_identifier"},"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":"The external system pushes the planned trips to the trip import webhook."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"image","inline":true,"attributes":{"alt":"trip import flow","src":"https://api.qargo.com/docs/static/trip_import_flow.svg"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/webhook/trip-import","summary":"Import Trip","prefix":{"name":"post","color":"post"},"badges":[],"link":"/use-case-trip-import/trip-import-webhook","deprecated":false}]}]}]}]}},{"type":"group","label":"Use case / Visibility","link":"/docs/use-case-visibility","routeSlug":"/docs/use-case-visibility","items":[{"label":"Accounting Visibility Event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-visibility/accounting_visibility_eventhttps____accounting_visibility_event_receiving_payload__post","routeSlug":"/docs/use-case-visibility/accounting_visibility_eventhttps____accounting_visibility_event_receiving_payload__post","metadata":{"seo":{"title":"Accounting Visibility Event","description":"Webhook for updates to orders and trips. Subscribe to this endpoint to receive updates."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Accounting_visibility_eventhttps____accounting_visibility_event_receiving_payload__post","name":"Accounting Visibility Event","isWebhook":false,"pointer":"/paths/https:~1~1<accounting-visibility-event-receiving-payload>/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Accounting Visibility Event","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Webhook for updates to orders and trips. Subscribe to this endpoint to receive updates.\n\nNote that both support our canonical VisibilityUpdate schema,\nbut the body can also be a custom mapped format."},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_107"}},"schemaId":"schema_107","pointer":"/paths/https:~1~1<accounting-visibility-event-receiving-payload>/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"https://<accounting-visibility-event-receiving-payload>","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_107"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"https://<accounting-visibility-event-receiving-payload>","href":"use-case-visibility/accounting_visibility_eventhttps____accounting_visibility_event_receiving_payload__post","openApiOperationId":"Accounting_visibility_eventhttps____accounting_visibility_event_receiving_payload__post","summary":"Accounting Visibility Event"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"schema_107","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_107"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}},"schemaId":"schema_106"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/https:~1~1<accounting-visibility-event-receiving-payload>/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_106","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-visibility/accounting_visibility_eventhttps____accounting_visibility_event_receiving_payload__post"}],"panels":[]}]},"httpPath":"https://<accounting-visibility-event-receiving-payload>"},{"label":"Operational Visibility Event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/use-case-visibility/operational_visibility_event_webhook_post","routeSlug":"/docs/use-case-visibility/operational_visibility_event_webhook_post","metadata":{"seo":{"title":"Operational Visibility Event","description":"Webhook for updates to orders and trips. Subscribe to this endpoint to receive updates."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"operational_visibility_event_webhook_post","name":"Operational Visibility Event","isWebhook":false,"pointer":"/paths/https:~1~1<visibility-event-receiving-endpoint>/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Operational Visibility Event","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":"Webhook for updates to orders and trips. Subscribe to this endpoint to receive updates."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, Qargo sends payloads using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OperationalVisibilityUpdate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" schema:"},"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":"code","inline":true,"attributes":{"content":"order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OrderUpdate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"StopUpdate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DocumentUpdate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EtaUpdate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HandlingUnitUpdate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" events."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OrderImportUpdate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and other events not listed above may not include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not populated"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"by default; including it requires a custom webhook format configured by Qargo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom webhook format configured by Qargo may use a different structure."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_117"}},"schemaId":"schema_117","pointer":"/paths/https:~1~1<visibility-event-receiving-endpoint>/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"https://<visibility-event-receiving-endpoint>","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_117"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"https://<visibility-event-receiving-endpoint>","href":"use-case-visibility/operational_visibility_event_webhook_post","openApiOperationId":"operational_visibility_event_webhook_post","summary":"Operational Visibility Event"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"schema_117","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_117"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}},"schemaId":"schema_106"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/https:~1~1<visibility-event-receiving-endpoint>/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_106","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/use-case-visibility/operational_visibility_event_webhook_post"}],"panels":[]}]},"httpPath":"https://<visibility-event-receiving-endpoint>"}],"content":{"contentType":"group","meta":{"name":"Use case / Visibility"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Use case / Visibility","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"https://<accounting-visibility-event-receiving-payload>","summary":"Accounting Visibility Event","prefix":{"name":"post","color":"post"},"badges":[],"link":"/use-case-visibility/accounting_visibility_eventhttps____accounting_visibility_event_receiving_payload__post","deprecated":false},{"title":"https://<visibility-event-receiving-endpoint>","summary":"Operational Visibility Event","prefix":{"name":"post","color":"post"},"badges":[],"link":"/use-case-visibility/operational_visibility_event_webhook_post","deprecated":false}]}]}]}]}},{"type":"separator","label":"API","content":null},{"type":"group","label":"API / Accounting","link":"/docs/api-accounting","routeSlug":"/docs/api-accounting","items":[{"label":"List Accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/list_accounts_v1_accounting_accounts_get","routeSlug":"/docs/api-accounting/list_accounts_v1_accounting_accounts_get","metadata":{"seo":{"title":"List Accounts","description":"Lists accounting codes (GL / nominal codes) for the tenant, with optional filtering and pagination."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"List_accounts_v1_accounting_accounts_get","name":"List Accounts","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1accounts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Accounts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists accounting codes (GL / nominal codes) for the tenant, with optional filtering and pagination."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_89","description":"Pagination cursor. Mutually exclusive with other query parameters"},{"name":"archived","in":"query","schemaId":"schema_90","description":"Filter by archived status. Omit to return all accounts."},{"name":"billing_entity_code","in":"query","schemaId":"schema_91","description":"Filter by billing entity code."},{"name":"code","in":"query","schemaId":"schema_92","description":"Accounting code to match exactly."},{"name":"code:in","in":"query","schemaId":"schema_93","description":"Accounting codes to match. Comma-separated list."}],"pointer":"/paths/~1v1~1accounting~1accounts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/accounts","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_89"},{"name":"archived","in":"query","required":false,"schemaId":"schema_90"},{"name":"billing_entity_code","in":"query","required":false,"schemaId":"schema_91"},{"name":"code","in":"query","required":false,"schemaId":"schema_92"},{"name":"code:in","in":"query","required":false,"schemaId":"schema_93"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/accounts","href":"api-accounting/list_accounts_v1_accounting_accounts_get","openApiOperationId":"List_accounts_v1_accounting_accounts_get","summary":"List Accounts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListAccountOutput"}},"schemaId":"components/schemas/ListAccountOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1accounts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListAccountOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListAccountOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/list_accounts_v1_accounting_accounts_get"}],"panels":[]}]},"httpPath":"/v1/accounting/accounts"},{"label":"Retrieve Account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/retrieve_account_v1_accounting_accounts__id__get","routeSlug":"/docs/api-accounting/retrieve_account_v1_accounting_accounts__id__get","metadata":{"seo":{"title":"Retrieve Account","description":"Retrieves a single accounting code (GL / nominal code) by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Retrieve_account_v1_accounting_accounts__id__get","name":"Retrieve Account","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1accounts~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a single accounting code (GL / nominal code) by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1accounts~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/accounts/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/accounts/{id}","href":"api-accounting/retrieve_account_v1_accounting_accounts__id__get","openApiOperationId":"Retrieve_account_v1_accounting_accounts__id__get","summary":"Retrieve Account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/api__accounting__models__master_data__AccountOutput"}},"schemaId":"components/schemas/api__accounting__models__master_data__AccountOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1accounts~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/api__accounting__models__master_data__AccountOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/api__accounting__models__master_data__AccountOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/retrieve_account_v1_accounting_accounts__id__get"}],"panels":[]}]},"httpPath":"/v1/accounting/accounts/{id}"},{"label":"Create An Exchange Rate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/create_an_exchange_rate_v1_accounting_exchange_rate_post","routeSlug":"/docs/api-accounting/create_an_exchange_rate_v1_accounting_exchange_rate_post","metadata":{"seo":{"title":"Create An Exchange Rate","description":"Creates an exchange rate in Qargo for the given currency pair and date."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create_an_exchange_rate_v1_accounting_exchange_rate_post","name":"Create An Exchange Rate","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1exchange-rate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create An Exchange Rate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates an exchange rate in Qargo for the given currency pair and date."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExchangeRateInput"}},"schemaId":"components/schemas/ExchangeRateInput","pointer":"/paths/~1v1~1accounting~1exchange-rate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/accounting/exchange-rate","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ExchangeRateInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/exchange-rate","href":"api-accounting/create_an_exchange_rate_v1_accounting_exchange_rate_post","openApiOperationId":"Create_an_exchange_rate_v1_accounting_exchange_rate_post","summary":"Create An Exchange Rate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/ExchangeRateInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExchangeRateInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExchangeRateOutput"}},"schemaId":"components/schemas/ExchangeRateOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1exchange-rate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExchangeRateOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExchangeRateOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/create_an_exchange_rate_v1_accounting_exchange_rate_post"}],"panels":[]}]},"httpPath":"/v1/accounting/exchange-rate"},{"label":"List Exchange Rates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/list_exchange_rates_v1_accounting_exchange_rate_get","routeSlug":"/docs/api-accounting/list_exchange_rates_v1_accounting_exchange_rate_get","metadata":{"seo":{"title":"List Exchange Rates","description":"Retrieves a list of exchange rates with optional currency and date filters. When filtering by both from_currency and to_currency, results are returned in the requested direction regardless of how they are stored internally."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"List_exchange_rates_v1_accounting_exchange_rate_get","name":"List Exchange Rates","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1exchange-rate/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Exchange Rates","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":"Retrieves a list of exchange rates with optional currency and date filters. When filtering by both from_currency and to_currency, results are returned in the requested direction regardless of how they are stored internally."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_89","description":"Pagination cursor. Mutually exclusive with other query parameters"},{"name":"from_currency","in":"query","schemaId":"schema_95","description":"Filter by source currency code (ISO 4217)."},{"name":"from_currency:in","in":"query","schemaId":"schema_96","description":"Source currency codes to match (ISO 4217). Comma-separated list. Matches either side of the currency pair."},{"name":"to_currency","in":"query","schemaId":"schema_97","description":"Filter by target currency code (ISO 4217)."},{"name":"to_currency:in","in":"query","schemaId":"schema_98","description":"Target currency codes to match (ISO 4217). Comma-separated list. Matches either side of the currency pair."},{"name":"exchange_rate_date:gte","in":"query","schemaId":"schema_99","description":"Filter exchange rates on or after this date."},{"name":"exchange_rate_date:lte","in":"query","schemaId":"schema_100","description":"Filter exchange rates on or before this date."}],"pointer":"/paths/~1v1~1accounting~1exchange-rate/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/exchange-rate","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_89"},{"name":"from_currency","in":"query","required":false,"schemaId":"schema_95"},{"name":"from_currency:in","in":"query","required":false,"schemaId":"schema_96"},{"name":"to_currency","in":"query","required":false,"schemaId":"schema_97"},{"name":"to_currency:in","in":"query","required":false,"schemaId":"schema_98"},{"name":"exchange_rate_date:gte","in":"query","required":false,"schemaId":"schema_99"},{"name":"exchange_rate_date:lte","in":"query","required":false,"schemaId":"schema_100"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/exchange-rate","href":"api-accounting/list_exchange_rates_v1_accounting_exchange_rate_get","openApiOperationId":"List_exchange_rates_v1_accounting_exchange_rate_get","summary":"List Exchange Rates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListExchangeRateOutput"}},"schemaId":"components/schemas/ListExchangeRateOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1exchange-rate/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListExchangeRateOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListExchangeRateOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/list_exchange_rates_v1_accounting_exchange_rate_get"}],"panels":[]}]},"httpPath":"/v1/accounting/exchange-rate"},{"label":"Retrieve Purchase Credit Note","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/retrieve_purchase_credit_note_v1_accounting_purchase_credit_note__id__get","routeSlug":"/docs/api-accounting/retrieve_purchase_credit_note_v1_accounting_purchase_credit_note__id__get","metadata":{"seo":{"title":"Retrieve Purchase Credit Note","description":"Retrieve Purchase Credit Note"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Retrieve_purchase_credit_note_v1_accounting_purchase_credit_note__id__get","name":"Retrieve Purchase Credit Note","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1purchase-credit-note~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Purchase Credit Note","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1purchase-credit-note~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/purchase-credit-note/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/purchase-credit-note/{id}","href":"api-accounting/retrieve_purchase_credit_note_v1_accounting_purchase_credit_note__id__get","openApiOperationId":"Retrieve_purchase_credit_note_v1_accounting_purchase_credit_note__id__get","summary":"Retrieve Purchase Credit Note"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchaseCreditNote"}},"schemaId":"components/schemas/PurchaseCreditNote"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1purchase-credit-note~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PurchaseCreditNote","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchaseCreditNote"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/retrieve_purchase_credit_note_v1_accounting_purchase_credit_note__id__get"}],"panels":[]}]},"httpPath":"/v1/accounting/purchase-credit-note/{id}"},{"label":"Update Purchase Credit Note","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/update_purchase_credit_note_v1_accounting_purchase_credit_note__id__patch","routeSlug":"/docs/api-accounting/update_purchase_credit_note_v1_accounting_purchase_credit_note__id__patch","metadata":{"seo":{"title":"Update Purchase Credit Note","description":"Update Purchase Credit Note"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update_purchase_credit_note_v1_accounting_purchase_credit_note__id__patch","name":"Update Purchase Credit Note","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1purchase-credit-note~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Purchase Credit Note","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1purchase-credit-note~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PurchaseCreditNoteInput"}},"schemaId":"components/schemas/PurchaseCreditNoteInput","pointer":"/paths/~1v1~1accounting~1purchase-credit-note~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/accounting/purchase-credit-note/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PurchaseCreditNoteInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/purchase-credit-note/{id}","href":"api-accounting/update_purchase_credit_note_v1_accounting_purchase_credit_note__id__patch","openApiOperationId":"Update_purchase_credit_note_v1_accounting_purchase_credit_note__id__patch","summary":"Update Purchase Credit Note"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/PurchaseCreditNoteInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PurchaseCreditNoteInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchaseCreditNote"}},"schemaId":"components/schemas/PurchaseCreditNote"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1purchase-credit-note~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PurchaseCreditNote","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchaseCreditNote"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/update_purchase_credit_note_v1_accounting_purchase_credit_note__id__patch"}],"panels":[]}]},"httpPath":"/v1/accounting/purchase-credit-note/{id}"},{"label":"Retrieve Purchase Credit Note Documents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/retrieve_purchase_credit_note_documents_v1_accounting_purchase_credit_note__id__documents_get","routeSlug":"/docs/api-accounting/retrieve_purchase_credit_note_documents_v1_accounting_purchase_credit_note__id__documents_get","metadata":{"seo":{"title":"Retrieve Purchase Credit Note Documents","description":"Retrieve Purchase Credit Note Documents"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Retrieve_purchase_credit_note_documents_v1_accounting_purchase_credit_note__id__documents_get","name":"Retrieve Purchase Credit Note Documents","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1purchase-credit-note~1{id}~1documents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Purchase Credit Note Documents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1purchase-credit-note~1{id}~1documents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/purchase-credit-note/{id}/documents","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/purchase-credit-note/{id}/documents","href":"api-accounting/retrieve_purchase_credit_note_documents_v1_accounting_purchase_credit_note__id__documents_get","openApiOperationId":"Retrieve_purchase_credit_note_documents_v1_accounting_purchase_credit_note__id__documents_get","summary":"Retrieve Purchase Credit Note Documents"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1purchase-credit-note~1{id}~1documents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/retrieve_purchase_credit_note_documents_v1_accounting_purchase_credit_note__id__documents_get"}],"panels":[]}]},"httpPath":"/v1/accounting/purchase-credit-note/{id}/documents"},{"label":"Report Refund Status For Purchase Credit Note","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/report_refund_status_for_purchase_credit_note_v1_accounting_purchase_credit_note__id__refund_update_status_post","routeSlug":"/docs/api-accounting/report_refund_status_for_purchase_credit_note_v1_accounting_purchase_credit_note__id__refund_update_status_post","metadata":{"seo":{"title":"Report Refund Status For Purchase Credit Note","description":"Report Refund Status For Purchase Credit Note"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Report_refund_status_for_purchase_credit_note_v1_accounting_purchase_credit_note__id__refund_update_status_post","name":"Report Refund Status For Purchase Credit Note","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1purchase-credit-note~1{id}~1refund~1update-status/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Report Refund Status For Purchase Credit Note","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1purchase-credit-note~1{id}~1refund~1update-status/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RefundStatusUpdate"}},"schemaId":"components/schemas/RefundStatusUpdate","pointer":"/paths/~1v1~1accounting~1purchase-credit-note~1{id}~1refund~1update-status/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/accounting/purchase-credit-note/{id}/refund/update-status","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RefundStatusUpdate"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/purchase-credit-note/{id}/refund/update-status","href":"api-accounting/report_refund_status_for_purchase_credit_note_v1_accounting_purchase_credit_note__id__refund_update_status_post","openApiOperationId":"Report_refund_status_for_purchase_credit_note_v1_accounting_purchase_credit_note__id__refund_update_status_post","summary":"Report Refund Status For Purchase Credit Note"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/RefundStatusUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RefundStatusUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RefundStatusUpdate"}},"schemaId":"components/schemas/RefundStatusUpdate"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1purchase-credit-note~1{id}~1refund~1update-status/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RefundStatusUpdate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RefundStatusUpdate"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/report_refund_status_for_purchase_credit_note_v1_accounting_purchase_credit_note__id__refund_update_status_post"}],"panels":[]}]},"httpPath":"/v1/accounting/purchase-credit-note/{id}/refund/update-status"},{"label":"Retrieve Purchase Invoice","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/retrieve_purchase_invoice_v1_accounting_purchase_invoice__id__get","routeSlug":"/docs/api-accounting/retrieve_purchase_invoice_v1_accounting_purchase_invoice__id__get","metadata":{"seo":{"title":"Retrieve Purchase Invoice","description":"Retrieve Purchase Invoice"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Retrieve_purchase_invoice_v1_accounting_purchase_invoice__id__get","name":"Retrieve Purchase Invoice","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1purchase-invoice~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Purchase Invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1purchase-invoice~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/purchase-invoice/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/purchase-invoice/{id}","href":"api-accounting/retrieve_purchase_invoice_v1_accounting_purchase_invoice__id__get","openApiOperationId":"Retrieve_purchase_invoice_v1_accounting_purchase_invoice__id__get","summary":"Retrieve Purchase Invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchaseInvoice"}},"schemaId":"components/schemas/PurchaseInvoice"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1purchase-invoice~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PurchaseInvoice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchaseInvoice"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/retrieve_purchase_invoice_v1_accounting_purchase_invoice__id__get"}],"panels":[]}]},"httpPath":"/v1/accounting/purchase-invoice/{id}"},{"label":"Update Purchase Invoice","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/update_purchase_invoice_v1_accounting_purchase_invoice__id__patch","routeSlug":"/docs/api-accounting/update_purchase_invoice_v1_accounting_purchase_invoice__id__patch","metadata":{"seo":{"title":"Update Purchase Invoice","description":"Update Purchase Invoice"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update_purchase_invoice_v1_accounting_purchase_invoice__id__patch","name":"Update Purchase Invoice","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1purchase-invoice~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Purchase Invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1purchase-invoice~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PurchaseInvoiceInput"}},"schemaId":"components/schemas/PurchaseInvoiceInput","pointer":"/paths/~1v1~1accounting~1purchase-invoice~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/accounting/purchase-invoice/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PurchaseInvoiceInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/purchase-invoice/{id}","href":"api-accounting/update_purchase_invoice_v1_accounting_purchase_invoice__id__patch","openApiOperationId":"Update_purchase_invoice_v1_accounting_purchase_invoice__id__patch","summary":"Update Purchase Invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/PurchaseInvoiceInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PurchaseInvoiceInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchaseInvoice"}},"schemaId":"components/schemas/PurchaseInvoice"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1purchase-invoice~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PurchaseInvoice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchaseInvoice"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/update_purchase_invoice_v1_accounting_purchase_invoice__id__patch"}],"panels":[]}]},"httpPath":"/v1/accounting/purchase-invoice/{id}"},{"label":"Retrieve Purchase Invoice Documents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/retrieve_purchase_invoice_documents_v1_accounting_purchase_invoice__id__documents_get","routeSlug":"/docs/api-accounting/retrieve_purchase_invoice_documents_v1_accounting_purchase_invoice__id__documents_get","metadata":{"seo":{"title":"Retrieve Purchase Invoice Documents","description":"Retrieve Purchase Invoice Documents"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Retrieve_purchase_invoice_documents_v1_accounting_purchase_invoice__id__documents_get","name":"Retrieve Purchase Invoice Documents","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1purchase-invoice~1{id}~1documents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Purchase Invoice Documents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1purchase-invoice~1{id}~1documents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/purchase-invoice/{id}/documents","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/purchase-invoice/{id}/documents","href":"api-accounting/retrieve_purchase_invoice_documents_v1_accounting_purchase_invoice__id__documents_get","openApiOperationId":"Retrieve_purchase_invoice_documents_v1_accounting_purchase_invoice__id__documents_get","summary":"Retrieve Purchase Invoice Documents"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_102"}},"schemaId":"schema_102"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1purchase-invoice~1{id}~1documents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_102","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_102"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/retrieve_purchase_invoice_documents_v1_accounting_purchase_invoice__id__documents_get"}],"panels":[]}]},"httpPath":"/v1/accounting/purchase-invoice/{id}/documents"},{"label":"Report Payment Status For Purchase Invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/report_payment_status_for_purchase_invoice_v1_accounting_purchase_invoice__id__payment_update_status_post","routeSlug":"/docs/api-accounting/report_payment_status_for_purchase_invoice_v1_accounting_purchase_invoice__id__payment_update_status_post","metadata":{"seo":{"title":"Report Payment Status For Purchase Invoice","description":"Report Payment Status For Purchase Invoice"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Report_payment_status_for_purchase_invoice_v1_accounting_purchase_invoice__id__payment_update_status_post","name":"Report Payment Status For Purchase Invoice","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1purchase-invoice~1{id}~1payment~1update-status/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Report Payment Status For Purchase Invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1purchase-invoice~1{id}~1payment~1update-status/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}},"schemaId":"components/schemas/PaymentStatusUpdate","pointer":"/paths/~1v1~1accounting~1purchase-invoice~1{id}~1payment~1update-status/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/accounting/purchase-invoice/{id}/payment/update-status","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/purchase-invoice/{id}/payment/update-status","href":"api-accounting/report_payment_status_for_purchase_invoice_v1_accounting_purchase_invoice__id__payment_update_status_post","openApiOperationId":"Report_payment_status_for_purchase_invoice_v1_accounting_purchase_invoice__id__payment_update_status_post","summary":"Report Payment Status For Purchase Invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/PaymentStatusUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}},"schemaId":"components/schemas/PaymentStatusUpdate"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1purchase-invoice~1{id}~1payment~1update-status/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentStatusUpdate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/report_payment_status_for_purchase_invoice_v1_accounting_purchase_invoice__id__payment_update_status_post"}],"panels":[]}]},"httpPath":"/v1/accounting/purchase-invoice/{id}/payment/update-status"},{"label":"Create A Sales Credit Note","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/create_a_sales_credit_note_v1_accounting_sales_credit_note__post","routeSlug":"/docs/api-accounting/create_a_sales_credit_note_v1_accounting_sales_credit_note__post","metadata":{"seo":{"title":"Create A Sales Credit Note","description":"Create A Sales Credit Note"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create_a_sales_credit_note_v1_accounting_sales_credit_note__post","name":"Create A Sales Credit Note","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sales-credit-note~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create A Sales Credit Note","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SalesCreditNoteInput"}},"schemaId":"components/schemas/SalesCreditNoteInput","pointer":"/paths/~1v1~1accounting~1sales-credit-note~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/accounting/sales-credit-note/","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SalesCreditNoteInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sales-credit-note/","href":"api-accounting/create_a_sales_credit_note_v1_accounting_sales_credit_note__post","openApiOperationId":"Create_a_sales_credit_note_v1_accounting_sales_credit_note__post","summary":"Create A Sales Credit Note"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/SalesCreditNoteInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SalesCreditNoteInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SalesCreditNoteOutput"}},"schemaId":"components/schemas/SalesCreditNoteOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sales-credit-note~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SalesCreditNoteOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SalesCreditNoteOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/create_a_sales_credit_note_v1_accounting_sales_credit_note__post"}],"panels":[]}]},"httpPath":"/v1/accounting/sales-credit-note/"},{"label":"Retrieve Sales Credit Note","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/retrieve_sales_credit_note_v1_accounting_sales_credit_note__id__get","routeSlug":"/docs/api-accounting/retrieve_sales_credit_note_v1_accounting_sales_credit_note__id__get","metadata":{"seo":{"title":"Retrieve Sales Credit Note","description":"Retrieve Sales Credit Note"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Retrieve_sales_credit_note_v1_accounting_sales_credit_note__id__get","name":"Retrieve Sales Credit Note","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sales-credit-note~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Sales Credit Note","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1sales-credit-note~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/sales-credit-note/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sales-credit-note/{id}","href":"api-accounting/retrieve_sales_credit_note_v1_accounting_sales_credit_note__id__get","openApiOperationId":"Retrieve_sales_credit_note_v1_accounting_sales_credit_note__id__get","summary":"Retrieve Sales Credit Note"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SalesCreditNoteOutput"}},"schemaId":"components/schemas/SalesCreditNoteOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sales-credit-note~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SalesCreditNoteOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SalesCreditNoteOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/retrieve_sales_credit_note_v1_accounting_sales_credit_note__id__get"}],"panels":[]}]},"httpPath":"/v1/accounting/sales-credit-note/{id}"},{"label":"Update Credit Note","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/update_credit_note_v1_accounting_sales_credit_note__id__patch","routeSlug":"/docs/api-accounting/update_credit_note_v1_accounting_sales_credit_note__id__patch","metadata":{"seo":{"title":"Update Credit Note","description":"Update Credit Note"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update_credit_note_v1_accounting_sales_credit_note__id__patch","name":"Update Credit Note","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sales-credit-note~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Credit Note","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1sales-credit-note~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SalesCreditNotePatchInput"}},"schemaId":"components/schemas/SalesCreditNotePatchInput","pointer":"/paths/~1v1~1accounting~1sales-credit-note~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/accounting/sales-credit-note/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SalesCreditNotePatchInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sales-credit-note/{id}","href":"api-accounting/update_credit_note_v1_accounting_sales_credit_note__id__patch","openApiOperationId":"Update_credit_note_v1_accounting_sales_credit_note__id__patch","summary":"Update Credit Note"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/SalesCreditNotePatchInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SalesCreditNotePatchInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SalesCreditNoteOutput"}},"schemaId":"components/schemas/SalesCreditNoteOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sales-credit-note~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SalesCreditNoteOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SalesCreditNoteOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/update_credit_note_v1_accounting_sales_credit_note__id__patch"}],"panels":[]}]},"httpPath":"/v1/accounting/sales-credit-note/{id}"},{"label":"Retrieve Sales Credit Note Documents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/retrieve_sales_credit_note_documents_v1_accounting_sales_credit_note__id__documents_get","routeSlug":"/docs/api-accounting/retrieve_sales_credit_note_documents_v1_accounting_sales_credit_note__id__documents_get","metadata":{"seo":{"title":"Retrieve Sales Credit Note Documents","description":"Retrieve Sales Credit Note Documents"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Retrieve_sales_credit_note_documents_v1_accounting_sales_credit_note__id__documents_get","name":"Retrieve Sales Credit Note Documents","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sales-credit-note~1{id}~1documents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Sales Credit Note Documents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1sales-credit-note~1{id}~1documents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/sales-credit-note/{id}/documents","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sales-credit-note/{id}/documents","href":"api-accounting/retrieve_sales_credit_note_documents_v1_accounting_sales_credit_note__id__documents_get","openApiOperationId":"Retrieve_sales_credit_note_documents_v1_accounting_sales_credit_note__id__documents_get","summary":"Retrieve Sales Credit Note Documents"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_103"}},"schemaId":"schema_103"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sales-credit-note~1{id}~1documents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_103","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_103"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/retrieve_sales_credit_note_documents_v1_accounting_sales_credit_note__id__documents_get"}],"panels":[]}]},"httpPath":"/v1/accounting/sales-credit-note/{id}/documents"},{"label":"Report Refund Status For Sales Credit Note","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/report_refund_status_for_sales_credit_note_v1_accounting_sales_credit_note__id__refund_update_status_post","routeSlug":"/docs/api-accounting/report_refund_status_for_sales_credit_note_v1_accounting_sales_credit_note__id__refund_update_status_post","metadata":{"seo":{"title":"Report Refund Status For Sales Credit Note","description":"Report Refund Status For Sales Credit Note"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Report_refund_status_for_sales_credit_note_v1_accounting_sales_credit_note__id__refund_update_status_post","name":"Report Refund Status For Sales Credit Note","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sales-credit-note~1{id}~1refund~1update-status/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Report Refund Status For Sales Credit Note","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1sales-credit-note~1{id}~1refund~1update-status/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RefundStatusUpdate"}},"schemaId":"components/schemas/RefundStatusUpdate","pointer":"/paths/~1v1~1accounting~1sales-credit-note~1{id}~1refund~1update-status/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/accounting/sales-credit-note/{id}/refund/update-status","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RefundStatusUpdate"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sales-credit-note/{id}/refund/update-status","href":"api-accounting/report_refund_status_for_sales_credit_note_v1_accounting_sales_credit_note__id__refund_update_status_post","openApiOperationId":"Report_refund_status_for_sales_credit_note_v1_accounting_sales_credit_note__id__refund_update_status_post","summary":"Report Refund Status For Sales Credit Note"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/RefundStatusUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RefundStatusUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RefundStatusUpdate"}},"schemaId":"components/schemas/RefundStatusUpdate"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sales-credit-note~1{id}~1refund~1update-status/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RefundStatusUpdate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RefundStatusUpdate"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/report_refund_status_for_sales_credit_note_v1_accounting_sales_credit_note__id__refund_update_status_post"}],"panels":[]}]},"httpPath":"/v1/accounting/sales-credit-note/{id}/refund/update-status"},{"label":"Create A Sales Invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/create_a_sales_invoice_v1_accounting_sales_invoice__post","routeSlug":"/docs/api-accounting/create_a_sales_invoice_v1_accounting_sales_invoice__post","metadata":{"seo":{"title":"Create A Sales Invoice","description":"Create A Sales Invoice"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create_a_sales_invoice_v1_accounting_sales_invoice__post","name":"Create A Sales Invoice","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sales-invoice~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create A Sales Invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SalesInvoiceInput"}},"schemaId":"components/schemas/SalesInvoiceInput","pointer":"/paths/~1v1~1accounting~1sales-invoice~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/accounting/sales-invoice/","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SalesInvoiceInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sales-invoice/","href":"api-accounting/create_a_sales_invoice_v1_accounting_sales_invoice__post","openApiOperationId":"Create_a_sales_invoice_v1_accounting_sales_invoice__post","summary":"Create A Sales Invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/SalesInvoiceInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SalesInvoiceInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SalesInvoiceOutput"}},"schemaId":"components/schemas/SalesInvoiceOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sales-invoice~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SalesInvoiceOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SalesInvoiceOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/create_a_sales_invoice_v1_accounting_sales_invoice__post"}],"panels":[]}]},"httpPath":"/v1/accounting/sales-invoice/"},{"label":"Retrieve Sales Invoice","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/retrieve_sales_invoice_v1_accounting_sales_invoice__id__get","routeSlug":"/docs/api-accounting/retrieve_sales_invoice_v1_accounting_sales_invoice__id__get","metadata":{"seo":{"title":"Retrieve Sales Invoice","description":"Retrieve Sales Invoice"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Retrieve_sales_invoice_v1_accounting_sales_invoice__id__get","name":"Retrieve Sales Invoice","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sales-invoice~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Sales Invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1sales-invoice~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/sales-invoice/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sales-invoice/{id}","href":"api-accounting/retrieve_sales_invoice_v1_accounting_sales_invoice__id__get","openApiOperationId":"Retrieve_sales_invoice_v1_accounting_sales_invoice__id__get","summary":"Retrieve Sales Invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SalesInvoiceOutput"}},"schemaId":"components/schemas/SalesInvoiceOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sales-invoice~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SalesInvoiceOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SalesInvoiceOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/retrieve_sales_invoice_v1_accounting_sales_invoice__id__get"}],"panels":[]}]},"httpPath":"/v1/accounting/sales-invoice/{id}"},{"label":"Update Sales Invoice","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/update_sales_invoice_v1_accounting_sales_invoice__id__patch","routeSlug":"/docs/api-accounting/update_sales_invoice_v1_accounting_sales_invoice__id__patch","metadata":{"seo":{"title":"Update Sales Invoice","description":"Update Sales Invoice"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update_sales_invoice_v1_accounting_sales_invoice__id__patch","name":"Update Sales Invoice","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sales-invoice~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Sales Invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1sales-invoice~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SalesInvoicePatchInput"}},"schemaId":"components/schemas/SalesInvoicePatchInput","pointer":"/paths/~1v1~1accounting~1sales-invoice~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/accounting/sales-invoice/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SalesInvoicePatchInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sales-invoice/{id}","href":"api-accounting/update_sales_invoice_v1_accounting_sales_invoice__id__patch","openApiOperationId":"Update_sales_invoice_v1_accounting_sales_invoice__id__patch","summary":"Update Sales Invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/SalesInvoicePatchInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SalesInvoicePatchInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SalesInvoiceOutput"}},"schemaId":"components/schemas/SalesInvoiceOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sales-invoice~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SalesInvoiceOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SalesInvoiceOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/update_sales_invoice_v1_accounting_sales_invoice__id__patch"}],"panels":[]}]},"httpPath":"/v1/accounting/sales-invoice/{id}"},{"label":"Retrieve Sales Invoice Documents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/retrieve_sales_invoice_documents_v1_accounting_sales_invoice__id__documents_get","routeSlug":"/docs/api-accounting/retrieve_sales_invoice_documents_v1_accounting_sales_invoice__id__documents_get","metadata":{"seo":{"title":"Retrieve Sales Invoice Documents","description":"Retrieve Sales Invoice Documents"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Retrieve_sales_invoice_documents_v1_accounting_sales_invoice__id__documents_get","name":"Retrieve Sales Invoice Documents","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sales-invoice~1{id}~1documents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Sales Invoice Documents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1sales-invoice~1{id}~1documents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/sales-invoice/{id}/documents","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sales-invoice/{id}/documents","href":"api-accounting/retrieve_sales_invoice_documents_v1_accounting_sales_invoice__id__documents_get","openApiOperationId":"Retrieve_sales_invoice_documents_v1_accounting_sales_invoice__id__documents_get","summary":"Retrieve Sales Invoice Documents"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_104"}},"schemaId":"schema_104"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sales-invoice~1{id}~1documents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_104","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_104"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/retrieve_sales_invoice_documents_v1_accounting_sales_invoice__id__documents_get"}],"panels":[]}]},"httpPath":"/v1/accounting/sales-invoice/{id}/documents"},{"label":"Report Payment Status For Sales Invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/report_payment_status_for_sales_invoice_v1_accounting_sales_invoice__id__payment_update_status_post","routeSlug":"/docs/api-accounting/report_payment_status_for_sales_invoice_v1_accounting_sales_invoice__id__payment_update_status_post","metadata":{"seo":{"title":"Report Payment Status For Sales Invoice","description":"Report Payment Status For Sales Invoice"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Report_payment_status_for_sales_invoice_v1_accounting_sales_invoice__id__payment_update_status_post","name":"Report Payment Status For Sales Invoice","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sales-invoice~1{id}~1payment~1update-status/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Report Payment Status For Sales Invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1sales-invoice~1{id}~1payment~1update-status/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}},"schemaId":"components/schemas/PaymentStatusUpdate","pointer":"/paths/~1v1~1accounting~1sales-invoice~1{id}~1payment~1update-status/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/accounting/sales-invoice/{id}/payment/update-status","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sales-invoice/{id}/payment/update-status","href":"api-accounting/report_payment_status_for_sales_invoice_v1_accounting_sales_invoice__id__payment_update_status_post","openApiOperationId":"Report_payment_status_for_sales_invoice_v1_accounting_sales_invoice__id__payment_update_status_post","summary":"Report Payment Status For Sales Invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/PaymentStatusUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}},"schemaId":"components/schemas/PaymentStatusUpdate"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sales-invoice~1{id}~1payment~1update-status/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentStatusUpdate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/report_payment_status_for_sales_invoice_v1_accounting_sales_invoice__id__payment_update_status_post"}],"panels":[]}]},"httpPath":"/v1/accounting/sales-invoice/{id}/payment/update-status"},{"label":"List Invoices/Credit Notes To Sync","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/list_invoices_credit_notes_to_sync_v1_accounting_sync_tasks_get","routeSlug":"/docs/api-accounting/list_invoices_credit_notes_to_sync_v1_accounting_sync_tasks_get","metadata":{"seo":{"title":"List Invoices/Credit Notes To Sync","description":"List Invoices/Credit Notes To Sync"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"List_invoices_credit_notes_to_sync_v1_accounting_sync_tasks_get","name":"List Invoices/Credit Notes To Sync","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sync-tasks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Invoices/Credit Notes To Sync","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"billing_entity_code","in":"query","schemaId":"schema_91","description":"Billing entity code to filter tasks, useful if multiple billing entities are linked to the same integration"}],"pointer":"/paths/~1v1~1accounting~1sync-tasks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/sync-tasks","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[{"name":"billing_entity_code","in":"query","required":false,"schemaId":"schema_91"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sync-tasks","href":"api-accounting/list_invoices_credit_notes_to_sync_v1_accounting_sync_tasks_get","openApiOperationId":"List_invoices_credit_notes_to_sync_v1_accounting_sync_tasks_get","summary":"List Invoices/Credit Notes To Sync"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AvailableTasks"}},"schemaId":"components/schemas/AvailableTasks"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sync-tasks/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AvailableTasks","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AvailableTasks"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/list_invoices_credit_notes_to_sync_v1_accounting_sync_tasks_get"}],"panels":[]}]},"httpPath":"/v1/accounting/sync-tasks"},{"label":"Get Details Of Invoice/Credit Note To Sync","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/get_details_of_invoice_credit_note_to_sync_v1_accounting_sync_tasks__id__get","routeSlug":"/docs/api-accounting/get_details_of_invoice_credit_note_to_sync_v1_accounting_sync_tasks__id__get","metadata":{"seo":{"title":"Get Details Of Invoice/Credit Note To Sync","description":"Get Details Of Invoice/Credit Note To Sync"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get_details_of_Invoice_Credit_note_to_sync_v1_accounting_sync_tasks__id__get","name":"Get Details Of Invoice/Credit Note To Sync","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sync-tasks~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Details Of Invoice/Credit Note To Sync","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1sync-tasks~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/sync-tasks/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sync-tasks/{id}","href":"api-accounting/get_details_of_invoice_credit_note_to_sync_v1_accounting_sync_tasks__id__get","openApiOperationId":"Get_details_of_Invoice_Credit_note_to_sync_v1_accounting_sync_tasks__id__get","summary":"Get Details Of Invoice/Credit Note To Sync"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaskDetail"}},"schemaId":"components/schemas/TaskDetail"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sync-tasks~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TaskDetail","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaskDetail"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/get_details_of_invoice_credit_note_to_sync_v1_accounting_sync_tasks__id__get"}],"panels":[]}]},"httpPath":"/v1/accounting/sync-tasks/{id}"},{"label":"Report Sync Status For Invoice/Credit Note","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/report_sync_status_for_invoice_credit_note_v1_accounting_sync_tasks__id__update_status_post","routeSlug":"/docs/api-accounting/report_sync_status_for_invoice_credit_note_v1_accounting_sync_tasks__id__update_status_post","metadata":{"seo":{"title":"Report Sync Status For Invoice/Credit Note","description":"Reports the sync status for an invoice/credit note task. No billing_entity_code is required."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Report_sync_status_for_invoice_credit_note_v1_accounting_sync_tasks__id__update_status_post","name":"Report Sync Status For Invoice/Credit Note","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sync-tasks~1{id}~1update-status/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Report Sync Status For Invoice/Credit Note","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":"Reports the sync status for an invoice/credit note task. No billing_entity_code is required."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1sync-tasks~1{id}~1update-status/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TaskUpdateInput"}},"schemaId":"components/schemas/TaskUpdateInput","pointer":"/paths/~1v1~1accounting~1sync-tasks~1{id}~1update-status/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/accounting/sync-tasks/{id}/update-status","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TaskUpdateInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sync-tasks/{id}/update-status","href":"api-accounting/report_sync_status_for_invoice_credit_note_v1_accounting_sync_tasks__id__update_status_post","openApiOperationId":"Report_sync_status_for_invoice_credit_note_v1_accounting_sync_tasks__id__update_status_post","summary":"Report Sync Status For Invoice/Credit Note"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/TaskUpdateInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TaskUpdateInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaskUpdate"}},"schemaId":"components/schemas/TaskUpdate"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sync-tasks~1{id}~1update-status/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TaskUpdate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaskUpdate"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/report_sync_status_for_invoice_credit_note_v1_accounting_sync_tasks__id__update_status_post"}],"panels":[]}]},"httpPath":"/v1/accounting/sync-tasks/{id}/update-status"},{"label":"List Tax Rates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/list_tax_rates_v1_accounting_tax_rates_get","routeSlug":"/docs/api-accounting/list_tax_rates_v1_accounting_tax_rates_get","metadata":{"seo":{"title":"List Tax Rates","description":"Lists tax rates for the tenant, with optional filtering and pagination."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"List_tax_rates_v1_accounting_tax_rates_get","name":"List Tax Rates","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1tax-rates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Tax Rates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists tax rates for the tenant, with optional filtering and pagination."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_89","description":"Pagination cursor. Mutually exclusive with other query parameters"},{"name":"archived","in":"query","schemaId":"schema_90","description":"Filter by archived status. Omit to return all tax rates."},{"name":"billing_entity_code","in":"query","schemaId":"schema_91","description":"Filter by billing entity code."},{"name":"code","in":"query","schemaId":"schema_92","description":"Tax rate code to match exactly."},{"name":"code:in","in":"query","schemaId":"schema_93","description":"Tax rate codes to match. Comma-separated list."}],"pointer":"/paths/~1v1~1accounting~1tax-rates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/tax-rates","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_89"},{"name":"archived","in":"query","required":false,"schemaId":"schema_90"},{"name":"billing_entity_code","in":"query","required":false,"schemaId":"schema_91"},{"name":"code","in":"query","required":false,"schemaId":"schema_92"},{"name":"code:in","in":"query","required":false,"schemaId":"schema_93"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/tax-rates","href":"api-accounting/list_tax_rates_v1_accounting_tax_rates_get","openApiOperationId":"List_tax_rates_v1_accounting_tax_rates_get","summary":"List Tax Rates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListTaxRateOutput"}},"schemaId":"components/schemas/ListTaxRateOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1tax-rates/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListTaxRateOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListTaxRateOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/list_tax_rates_v1_accounting_tax_rates_get"}],"panels":[]}]},"httpPath":"/v1/accounting/tax-rates"},{"label":"Retrieve Tax Rate","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/retrieve_tax_rate_v1_accounting_tax_rates__id__get","routeSlug":"/docs/api-accounting/retrieve_tax_rate_v1_accounting_tax_rates__id__get","metadata":{"seo":{"title":"Retrieve Tax Rate","description":"Retrieves a single tax rate by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Retrieve_tax_rate_v1_accounting_tax_rates__id__get","name":"Retrieve Tax Rate","isWebhook":false,"pointer":"/paths/~1v1~1accounting~1tax-rates~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Tax Rate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a single tax rate by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1tax-rates~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/tax-rates/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/tax-rates/{id}","href":"api-accounting/retrieve_tax_rate_v1_accounting_tax_rates__id__get","openApiOperationId":"Retrieve_tax_rate_v1_accounting_tax_rates__id__get","summary":"Retrieve Tax Rate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaxRateOutput"}},"schemaId":"components/schemas/TaxRateOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1tax-rates~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TaxRateOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaxRateOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/retrieve_tax_rate_v1_accounting_tax_rates__id__get"}],"panels":[]}]},"httpPath":"/v1/accounting/tax-rates/{id}"},{"label":"List Companies (Deprecated)","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/list_companies__deprecated__v1_accounting_company_get","routeSlug":"/docs/api-accounting/list_companies__deprecated__v1_accounting_company_get","metadata":{"seo":{"title":"List Companies (Deprecated)","description":"(deprecated, use /company instead)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_companies__deprecated__v1_accounting_company_get","name":"List Companies (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1accounting~1company/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Companies (Deprecated)","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"(deprecated, use /company instead)"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_89","description":"Pagination cursor. Mutually exclusive with other query parameters"},{"name":"updated_after","in":"query","schemaId":"schema_108","description":"Filter to fetch the companies updated after this time. Format is ISO 8601 YYYY-MM-DDTHH:MM:SSZ"},{"name":"code","in":"query","schemaId":"schema_92","description":"Company code to match exactly."},{"name":"code:in","in":"query","schemaId":"schema_93","description":"Company codes to match. Comma-separated list."},{"name":"accounting_customer_code","in":"query","schemaId":"schema_109","description":"Accounting customer code to match exactly. Holds the code of the default billing entity."},{"name":"accounting_customer_code:in","in":"query","schemaId":"schema_110","description":"Accounting customer codes to match. Comma-separated list. Holds the code of the default billing entity."}],"pointer":"/paths/~1v1~1accounting~1company/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/company","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_89"},{"name":"updated_after","in":"query","required":false,"schemaId":"schema_108"},{"name":"code","in":"query","required":false,"schemaId":"schema_92"},{"name":"code:in","in":"query","required":false,"schemaId":"schema_93"},{"name":"accounting_customer_code","in":"query","required":false,"schemaId":"schema_109"},{"name":"accounting_customer_code:in","in":"query","required":false,"schemaId":"schema_110"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/company","href":"api-accounting/list_companies__deprecated__v1_accounting_company_get","openApiOperationId":"list_companies__deprecated__v1_accounting_company_get","summary":"List Companies (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCompanyOutput"}},"schemaId":"components/schemas/ListCompanyOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1company/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCompanyOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCompanyOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/list_companies__deprecated__v1_accounting_company_get"}],"panels":[]}]},"httpPath":"/v1/accounting/company"},{"label":"Create Company (Deprecated)","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/create_company__deprecated__v1_accounting_company_post","routeSlug":"/docs/api-accounting/create_company__deprecated__v1_accounting_company_post","metadata":{"seo":{"title":"Create Company (Deprecated)","description":"(deprecated, use /company instead)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_company__deprecated__v1_accounting_company_post","name":"Create Company (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1accounting~1company/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Company (Deprecated)","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"(deprecated, use /company instead)"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyInput"}},"schemaId":"components/schemas/CompanyInput","pointer":"/paths/~1v1~1accounting~1company/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/accounting/company","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CompanyInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/company","href":"api-accounting/create_company__deprecated__v1_accounting_company_post","openApiOperationId":"create_company__deprecated__v1_accounting_company_post","summary":"Create Company (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/CompanyInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyDetailOutput"}},"schemaId":"components/schemas/CompanyDetailOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1company/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompanyDetailOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyDetailOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/create_company__deprecated__v1_accounting_company_post"}],"panels":[]}]},"httpPath":"/v1/accounting/company"},{"label":"Get Company (Deprecated)","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/get_company__deprecated__v1_accounting_company__id__get","routeSlug":"/docs/api-accounting/get_company__deprecated__v1_accounting_company__id__get","metadata":{"seo":{"title":"Get Company (Deprecated)","description":"(deprecated, use /company/{id} instead)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_company__deprecated__v1_accounting_company__id__get","name":"Get Company (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1accounting~1company~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Company (Deprecated)","isWebhook":false,"deprecated":true,"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":"(deprecated, use /company/{id} instead)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1company~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/company/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/company/{id}","href":"api-accounting/get_company__deprecated__v1_accounting_company__id__get","openApiOperationId":"get_company__deprecated__v1_accounting_company__id__get","summary":"Get Company (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyDetailOutput"}},"schemaId":"components/schemas/CompanyDetailOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1company~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompanyDetailOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyDetailOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/get_company__deprecated__v1_accounting_company__id__get"}],"panels":[]}]},"httpPath":"/v1/accounting/company/{id}"},{"label":"Update Company (Deprecated)","deprecated":true,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/update_company__deprecated__v1_accounting_company__id__put","routeSlug":"/docs/api-accounting/update_company__deprecated__v1_accounting_company__id__put","metadata":{"seo":{"title":"Update Company (Deprecated)","description":"(deprecated, use /company/{id} instead)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_company__deprecated__v1_accounting_company__id__put","name":"Update Company (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1accounting~1company~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Company (Deprecated)","isWebhook":false,"deprecated":true,"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":"(deprecated, use /company/{id} instead)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1company~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyInput"}},"schemaId":"components/schemas/CompanyInput","pointer":"/paths/~1v1~1accounting~1company~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/accounting/company/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CompanyInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/company/{id}","href":"api-accounting/update_company__deprecated__v1_accounting_company__id__put","openApiOperationId":"update_company__deprecated__v1_accounting_company__id__put","summary":"Update Company (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/CompanyInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyDetailOutput"}},"schemaId":"components/schemas/CompanyDetailOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1company~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompanyDetailOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyDetailOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/update_company__deprecated__v1_accounting_company__id__put"}],"panels":[]}]},"httpPath":"/v1/accounting/company/{id}"},{"label":"Update Company (Deprecated)","deprecated":true,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/update_company__deprecated__v1_accounting_company__id__patch","routeSlug":"/docs/api-accounting/update_company__deprecated__v1_accounting_company__id__patch","metadata":{"seo":{"title":"Update Company (Deprecated)","description":"(deprecated, use /company/{id} instead)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_company__deprecated__v1_accounting_company__id__patch","name":"Update Company (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1accounting~1company~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Company (Deprecated)","isWebhook":false,"deprecated":true,"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":"(deprecated, use /company/{id} instead)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1company~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyPartialInput"}},"schemaId":"components/schemas/CompanyPartialInput","pointer":"/paths/~1v1~1accounting~1company~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/accounting/company/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CompanyPartialInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/company/{id}","href":"api-accounting/update_company__deprecated__v1_accounting_company__id__patch","openApiOperationId":"update_company__deprecated__v1_accounting_company__id__patch","summary":"Update Company (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/CompanyPartialInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyPartialInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyDetailOutput"}},"schemaId":"components/schemas/CompanyDetailOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1company~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompanyDetailOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyDetailOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/update_company__deprecated__v1_accounting_company__id__patch"}],"panels":[]}]},"httpPath":"/v1/accounting/company/{id}"},{"label":"Archive Company (Deprecated)","deprecated":true,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/archive_company__deprecated__v1_accounting_company__id__delete","routeSlug":"/docs/api-accounting/archive_company__deprecated__v1_accounting_company__id__delete","metadata":{"seo":{"title":"Archive Company (Deprecated)","description":"Archive the company. This is a soft-delete: the company record is preserved and its archived_customer, archived_subcontractor, and archived_buyer_or_seller flags are set to true so it no longer appears in active lists.(deprecated, use /company/{id} instead)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Archive_company__deprecated__v1_accounting_company__id__delete","name":"Archive Company (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1accounting~1company~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Archive Company (Deprecated)","isWebhook":false,"deprecated":true,"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":"Archive the company. This is a soft-delete: the company record is preserved and its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"archived_customer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"archived_subcontractor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"archived_buyer_or_seller"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flags are set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" so it no longer appears in active lists.(deprecated, use /company/{id} instead)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1company~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/accounting/company/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/company/{id}","href":"api-accounting/archive_company__deprecated__v1_accounting_company__id__delete","openApiOperationId":"Archive_company__deprecated__v1_accounting_company__id__delete","summary":"Archive Company (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}},"schemaId":"schema_106"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1company~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_106","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/archive_company__deprecated__v1_accounting_company__id__delete"}],"panels":[]}]},"httpPath":"/v1/accounting/company/{id}"},{"label":"Retrieve Purchase Invoice (Deprecated)","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/retrieve_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__get","routeSlug":"/docs/api-accounting/retrieve_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__get","metadata":{"seo":{"title":"Retrieve Purchase Invoice (Deprecated)","description":"(deprecated, use /purchase-invoice/{id} instead)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Retrieve_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__get","name":"Retrieve Purchase Invoice (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1accounting~1purchase_invoice~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Purchase Invoice (Deprecated)","isWebhook":false,"deprecated":true,"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":"(deprecated, use /purchase-invoice/{id} instead)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1purchase_invoice~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/purchase_invoice/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/purchase_invoice/{id}","href":"api-accounting/retrieve_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__get","openApiOperationId":"Retrieve_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__get","summary":"Retrieve Purchase Invoice (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchaseInvoice"}},"schemaId":"components/schemas/PurchaseInvoice"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1purchase_invoice~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PurchaseInvoice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchaseInvoice"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/retrieve_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__get"}],"panels":[]}]},"httpPath":"/v1/accounting/purchase_invoice/{id}"},{"label":"Retrieve Purchase Invoice (Deprecated)","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/retrieve_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__get","routeSlug":"/docs/api-accounting/retrieve_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__get","metadata":{"seo":{"title":"Retrieve Purchase Invoice (Deprecated)","description":"(deprecated, use /purchase-invoice/{id} instead)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Retrieve_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__get","name":"Retrieve Purchase Invoice (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1accounting~1purchase_invoice~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Purchase Invoice (Deprecated)","isWebhook":false,"deprecated":true,"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":"(deprecated, use /purchase-invoice/{id} instead)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1purchase_invoice~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/purchase_invoice/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/purchase_invoice/{id}","href":"api-accounting/retrieve_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__get","openApiOperationId":"Retrieve_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__get","summary":"Retrieve Purchase Invoice (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchaseInvoice"}},"schemaId":"components/schemas/PurchaseInvoice"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1purchase_invoice~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PurchaseInvoice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchaseInvoice"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/retrieve_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__get"}],"panels":[]}]},"httpPath":"/v1/accounting/purchase_invoice/{id}"},{"label":"Update Purchase Invoice (Deprecated)","deprecated":true,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/update_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__patch","routeSlug":"/docs/api-accounting/update_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__patch","metadata":{"seo":{"title":"Update Purchase Invoice (Deprecated)","description":"(deprecated, use /purchase-invoice/{id} instead)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__patch","name":"Update Purchase Invoice (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1accounting~1purchase_invoice~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Purchase Invoice (Deprecated)","isWebhook":false,"deprecated":true,"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":"(deprecated, use /purchase-invoice/{id} instead)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1purchase_invoice~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PurchaseInvoiceInput"}},"schemaId":"components/schemas/PurchaseInvoiceInput","pointer":"/paths/~1v1~1accounting~1purchase_invoice~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/accounting/purchase_invoice/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PurchaseInvoiceInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/purchase_invoice/{id}","href":"api-accounting/update_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__patch","openApiOperationId":"Update_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__patch","summary":"Update Purchase Invoice (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/PurchaseInvoiceInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PurchaseInvoiceInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchaseInvoice"}},"schemaId":"components/schemas/PurchaseInvoice"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1purchase_invoice~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PurchaseInvoice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchaseInvoice"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/update_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__patch"}],"panels":[]}]},"httpPath":"/v1/accounting/purchase_invoice/{id}"},{"label":"Update Purchase Invoice (Deprecated)","deprecated":true,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/update_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__patch","routeSlug":"/docs/api-accounting/update_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__patch","metadata":{"seo":{"title":"Update Purchase Invoice (Deprecated)","description":"(deprecated, use /purchase-invoice/{id} instead)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__patch","name":"Update Purchase Invoice (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1accounting~1purchase_invoice~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Purchase Invoice (Deprecated)","isWebhook":false,"deprecated":true,"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":"(deprecated, use /purchase-invoice/{id} instead)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1purchase_invoice~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PurchaseInvoiceInput"}},"schemaId":"components/schemas/PurchaseInvoiceInput","pointer":"/paths/~1v1~1accounting~1purchase_invoice~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/accounting/purchase_invoice/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PurchaseInvoiceInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/purchase_invoice/{id}","href":"api-accounting/update_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__patch","openApiOperationId":"Update_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__patch","summary":"Update Purchase Invoice (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/PurchaseInvoiceInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PurchaseInvoiceInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchaseInvoice"}},"schemaId":"components/schemas/PurchaseInvoice"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1purchase_invoice~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PurchaseInvoice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchaseInvoice"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/update_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__patch"}],"panels":[]}]},"httpPath":"/v1/accounting/purchase_invoice/{id}"},{"label":"Retrieve Purchase Invoice Documents (Deprecated)","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/retrieve_purchase_invoice_documents__deprecated__v1_accounting_purchase_invoice__id__documents_get","routeSlug":"/docs/api-accounting/retrieve_purchase_invoice_documents__deprecated__v1_accounting_purchase_invoice__id__documents_get","metadata":{"seo":{"title":"Retrieve Purchase Invoice Documents (Deprecated)","description":"(deprecated, use /purchase-invoice/{id}/documents instead)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Retrieve_purchase_invoice_documents__deprecated__v1_accounting_purchase_invoice__id__documents_get","name":"Retrieve Purchase Invoice Documents (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1accounting~1purchase_invoice~1{id}~1documents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Purchase Invoice Documents (Deprecated)","isWebhook":false,"deprecated":true,"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":"(deprecated, use /purchase-invoice/{id}/documents instead)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1purchase_invoice~1{id}~1documents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/purchase_invoice/{id}/documents","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/purchase_invoice/{id}/documents","href":"api-accounting/retrieve_purchase_invoice_documents__deprecated__v1_accounting_purchase_invoice__id__documents_get","openApiOperationId":"Retrieve_purchase_invoice_documents__deprecated__v1_accounting_purchase_invoice__id__documents_get","summary":"Retrieve Purchase Invoice Documents (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_111"}},"schemaId":"schema_111"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1purchase_invoice~1{id}~1documents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_111","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_111"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/retrieve_purchase_invoice_documents__deprecated__v1_accounting_purchase_invoice__id__documents_get"}],"panels":[]}]},"httpPath":"/v1/accounting/purchase_invoice/{id}/documents"},{"label":"Retrieve Purchase Invoice Documents (Deprecated)","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/retrieve_purchase_invoice_documents__deprecated__v1_accounting_purchase_invoice__id__documents_get","routeSlug":"/docs/api-accounting/retrieve_purchase_invoice_documents__deprecated__v1_accounting_purchase_invoice__id__documents_get","metadata":{"seo":{"title":"Retrieve Purchase Invoice Documents (Deprecated)","description":"(deprecated, use /purchase-invoice/{id}/documents instead)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Retrieve_purchase_invoice_documents__deprecated__v1_accounting_purchase_invoice__id__documents_get","name":"Retrieve Purchase Invoice Documents (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1accounting~1purchase_invoice~1{id}~1documents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Purchase Invoice Documents (Deprecated)","isWebhook":false,"deprecated":true,"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":"(deprecated, use /purchase-invoice/{id}/documents instead)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1purchase_invoice~1{id}~1documents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/purchase_invoice/{id}/documents","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/purchase_invoice/{id}/documents","href":"api-accounting/retrieve_purchase_invoice_documents__deprecated__v1_accounting_purchase_invoice__id__documents_get","openApiOperationId":"Retrieve_purchase_invoice_documents__deprecated__v1_accounting_purchase_invoice__id__documents_get","summary":"Retrieve Purchase Invoice Documents (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_111"}},"schemaId":"schema_111"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1purchase_invoice~1{id}~1documents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_111","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_111"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/retrieve_purchase_invoice_documents__deprecated__v1_accounting_purchase_invoice__id__documents_get"}],"panels":[]}]},"httpPath":"/v1/accounting/purchase_invoice/{id}/documents"},{"label":"Report Payment Status For Purchase Invoice (Deprecated)","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/report_payment_status_for_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__payment_update_status_post","routeSlug":"/docs/api-accounting/report_payment_status_for_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__payment_update_status_post","metadata":{"seo":{"title":"Report Payment Status For Purchase Invoice (Deprecated)","description":"(deprecated, use /purchase-invoice/{id}/payment/update-status instead)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Report_payment_status_for_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__payment_update_status_post","name":"Report Payment Status For Purchase Invoice (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1accounting~1purchase_invoice~1{id}~1payment~1update-status/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Report Payment Status For Purchase Invoice (Deprecated)","isWebhook":false,"deprecated":true,"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":"(deprecated, use /purchase-invoice/{id}/payment/update-status instead)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1purchase_invoice~1{id}~1payment~1update-status/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}},"schemaId":"components/schemas/PaymentStatusUpdate","pointer":"/paths/~1v1~1accounting~1purchase_invoice~1{id}~1payment~1update-status/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/accounting/purchase_invoice/{id}/payment/update-status","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/purchase_invoice/{id}/payment/update-status","href":"api-accounting/report_payment_status_for_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__payment_update_status_post","openApiOperationId":"Report_payment_status_for_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__payment_update_status_post","summary":"Report Payment Status For Purchase Invoice (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/PaymentStatusUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}},"schemaId":"components/schemas/PaymentStatusUpdate"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1purchase_invoice~1{id}~1payment~1update-status/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentStatusUpdate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/report_payment_status_for_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__payment_update_status_post"}],"panels":[]}]},"httpPath":"/v1/accounting/purchase_invoice/{id}/payment/update-status"},{"label":"Report Payment Status For Purchase Invoice (Deprecated)","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/report_payment_status_for_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__payment_update_status_post","routeSlug":"/docs/api-accounting/report_payment_status_for_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__payment_update_status_post","metadata":{"seo":{"title":"Report Payment Status For Purchase Invoice (Deprecated)","description":"(deprecated, use /purchase-invoice/{id}/payment/update-status instead)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Report_payment_status_for_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__payment_update_status_post","name":"Report Payment Status For Purchase Invoice (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1accounting~1purchase_invoice~1{id}~1payment~1update-status/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Report Payment Status For Purchase Invoice (Deprecated)","isWebhook":false,"deprecated":true,"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":"(deprecated, use /purchase-invoice/{id}/payment/update-status instead)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1purchase_invoice~1{id}~1payment~1update-status/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}},"schemaId":"components/schemas/PaymentStatusUpdate","pointer":"/paths/~1v1~1accounting~1purchase_invoice~1{id}~1payment~1update-status/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/accounting/purchase_invoice/{id}/payment/update-status","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/purchase_invoice/{id}/payment/update-status","href":"api-accounting/report_payment_status_for_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__payment_update_status_post","openApiOperationId":"Report_payment_status_for_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__payment_update_status_post","summary":"Report Payment Status For Purchase Invoice (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/PaymentStatusUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}},"schemaId":"components/schemas/PaymentStatusUpdate"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1purchase_invoice~1{id}~1payment~1update-status/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentStatusUpdate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/report_payment_status_for_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__payment_update_status_post"}],"panels":[]}]},"httpPath":"/v1/accounting/purchase_invoice/{id}/payment/update-status"},{"label":"Retrieve Sales Credit Note (Deprecated)","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/retrieve_sales_credit_note__deprecated__v1_accounting_sales_credit_note__id__get","routeSlug":"/docs/api-accounting/retrieve_sales_credit_note__deprecated__v1_accounting_sales_credit_note__id__get","metadata":{"seo":{"title":"Retrieve Sales Credit Note (Deprecated)","description":"(deprecated, use /sales-credit-note/{id} instead)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Retrieve_sales_credit_note__deprecated__v1_accounting_sales_credit_note__id__get","name":"Retrieve Sales Credit Note (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sales_credit_note~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Sales Credit Note (Deprecated)","isWebhook":false,"deprecated":true,"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":"(deprecated, use /sales-credit-note/{id} instead)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1sales_credit_note~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/sales_credit_note/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sales_credit_note/{id}","href":"api-accounting/retrieve_sales_credit_note__deprecated__v1_accounting_sales_credit_note__id__get","openApiOperationId":"Retrieve_sales_credit_note__deprecated__v1_accounting_sales_credit_note__id__get","summary":"Retrieve Sales Credit Note (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SalesCreditNoteOutput"}},"schemaId":"components/schemas/SalesCreditNoteOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sales_credit_note~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SalesCreditNoteOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SalesCreditNoteOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/retrieve_sales_credit_note__deprecated__v1_accounting_sales_credit_note__id__get"}],"panels":[]}]},"httpPath":"/v1/accounting/sales_credit_note/{id}"},{"label":"Retrieve Sales Credit Note (Deprecated)","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/retrieve_sales_credit_note__deprecated__v1_accounting_sales_credit_note__id__get","routeSlug":"/docs/api-accounting/retrieve_sales_credit_note__deprecated__v1_accounting_sales_credit_note__id__get","metadata":{"seo":{"title":"Retrieve Sales Credit Note (Deprecated)","description":"(deprecated, use /sales-credit-note/{id} instead)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Retrieve_sales_credit_note__deprecated__v1_accounting_sales_credit_note__id__get","name":"Retrieve Sales Credit Note (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sales_credit_note~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Sales Credit Note (Deprecated)","isWebhook":false,"deprecated":true,"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":"(deprecated, use /sales-credit-note/{id} instead)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1sales_credit_note~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/sales_credit_note/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sales_credit_note/{id}","href":"api-accounting/retrieve_sales_credit_note__deprecated__v1_accounting_sales_credit_note__id__get","openApiOperationId":"Retrieve_sales_credit_note__deprecated__v1_accounting_sales_credit_note__id__get","summary":"Retrieve Sales Credit Note (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SalesCreditNoteOutput"}},"schemaId":"components/schemas/SalesCreditNoteOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sales_credit_note~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SalesCreditNoteOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SalesCreditNoteOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/retrieve_sales_credit_note__deprecated__v1_accounting_sales_credit_note__id__get"}],"panels":[]}]},"httpPath":"/v1/accounting/sales_credit_note/{id}"},{"label":"Update Credit Note (Deprecated)","deprecated":true,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/update_credit_note__deprecated__v1_accounting_sales_credit_note__id__patch","routeSlug":"/docs/api-accounting/update_credit_note__deprecated__v1_accounting_sales_credit_note__id__patch","metadata":{"seo":{"title":"Update Credit Note (Deprecated)","description":"(deprecated, use /sales-credit-note/{id} instead)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update_credit_note__deprecated__v1_accounting_sales_credit_note__id__patch","name":"Update Credit Note (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sales_credit_note~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Credit Note (Deprecated)","isWebhook":false,"deprecated":true,"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":"(deprecated, use /sales-credit-note/{id} instead)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1sales_credit_note~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SalesCreditNotePatchInput"}},"schemaId":"components/schemas/SalesCreditNotePatchInput","pointer":"/paths/~1v1~1accounting~1sales_credit_note~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/accounting/sales_credit_note/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SalesCreditNotePatchInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sales_credit_note/{id}","href":"api-accounting/update_credit_note__deprecated__v1_accounting_sales_credit_note__id__patch","openApiOperationId":"Update_credit_note__deprecated__v1_accounting_sales_credit_note__id__patch","summary":"Update Credit Note (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/SalesCreditNotePatchInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SalesCreditNotePatchInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SalesCreditNoteOutput"}},"schemaId":"components/schemas/SalesCreditNoteOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sales_credit_note~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SalesCreditNoteOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SalesCreditNoteOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/update_credit_note__deprecated__v1_accounting_sales_credit_note__id__patch"}],"panels":[]}]},"httpPath":"/v1/accounting/sales_credit_note/{id}"},{"label":"Update Credit Note (Deprecated)","deprecated":true,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/update_credit_note__deprecated__v1_accounting_sales_credit_note__id__patch","routeSlug":"/docs/api-accounting/update_credit_note__deprecated__v1_accounting_sales_credit_note__id__patch","metadata":{"seo":{"title":"Update Credit Note (Deprecated)","description":"(deprecated, use /sales-credit-note/{id} instead)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update_credit_note__deprecated__v1_accounting_sales_credit_note__id__patch","name":"Update Credit Note (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sales_credit_note~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Credit Note (Deprecated)","isWebhook":false,"deprecated":true,"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":"(deprecated, use /sales-credit-note/{id} instead)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1sales_credit_note~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SalesCreditNotePatchInput"}},"schemaId":"components/schemas/SalesCreditNotePatchInput","pointer":"/paths/~1v1~1accounting~1sales_credit_note~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/accounting/sales_credit_note/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SalesCreditNotePatchInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sales_credit_note/{id}","href":"api-accounting/update_credit_note__deprecated__v1_accounting_sales_credit_note__id__patch","openApiOperationId":"Update_credit_note__deprecated__v1_accounting_sales_credit_note__id__patch","summary":"Update Credit Note (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/SalesCreditNotePatchInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SalesCreditNotePatchInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SalesCreditNoteOutput"}},"schemaId":"components/schemas/SalesCreditNoteOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sales_credit_note~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SalesCreditNoteOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SalesCreditNoteOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/update_credit_note__deprecated__v1_accounting_sales_credit_note__id__patch"}],"panels":[]}]},"httpPath":"/v1/accounting/sales_credit_note/{id}"},{"label":"Retrieve Sales Credit Note Documents (Deprecated)","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/retrieve_sales_credit_note_documents__deprecated__v1_accounting_sales_credit_note__id__documents_get","routeSlug":"/docs/api-accounting/retrieve_sales_credit_note_documents__deprecated__v1_accounting_sales_credit_note__id__documents_get","metadata":{"seo":{"title":"Retrieve Sales Credit Note Documents (Deprecated)","description":"(deprecated, use /sales-credit-note/{id}/documents instead)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Retrieve_sales_credit_note_documents__deprecated__v1_accounting_sales_credit_note__id__documents_get","name":"Retrieve Sales Credit Note Documents (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sales_credit_note~1{id}~1documents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Sales Credit Note Documents (Deprecated)","isWebhook":false,"deprecated":true,"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":"(deprecated, use /sales-credit-note/{id}/documents instead)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1sales_credit_note~1{id}~1documents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/sales_credit_note/{id}/documents","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sales_credit_note/{id}/documents","href":"api-accounting/retrieve_sales_credit_note_documents__deprecated__v1_accounting_sales_credit_note__id__documents_get","openApiOperationId":"Retrieve_sales_credit_note_documents__deprecated__v1_accounting_sales_credit_note__id__documents_get","summary":"Retrieve Sales Credit Note Documents (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_112"}},"schemaId":"schema_112"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sales_credit_note~1{id}~1documents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_112","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_112"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/retrieve_sales_credit_note_documents__deprecated__v1_accounting_sales_credit_note__id__documents_get"}],"panels":[]}]},"httpPath":"/v1/accounting/sales_credit_note/{id}/documents"},{"label":"Retrieve Sales Credit Note Documents (Deprecated)","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/retrieve_sales_credit_note_documents__deprecated__v1_accounting_sales_credit_note__id__documents_get","routeSlug":"/docs/api-accounting/retrieve_sales_credit_note_documents__deprecated__v1_accounting_sales_credit_note__id__documents_get","metadata":{"seo":{"title":"Retrieve Sales Credit Note Documents (Deprecated)","description":"(deprecated, use /sales-credit-note/{id}/documents instead)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Retrieve_sales_credit_note_documents__deprecated__v1_accounting_sales_credit_note__id__documents_get","name":"Retrieve Sales Credit Note Documents (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sales_credit_note~1{id}~1documents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Sales Credit Note Documents (Deprecated)","isWebhook":false,"deprecated":true,"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":"(deprecated, use /sales-credit-note/{id}/documents instead)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1sales_credit_note~1{id}~1documents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/sales_credit_note/{id}/documents","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sales_credit_note/{id}/documents","href":"api-accounting/retrieve_sales_credit_note_documents__deprecated__v1_accounting_sales_credit_note__id__documents_get","openApiOperationId":"Retrieve_sales_credit_note_documents__deprecated__v1_accounting_sales_credit_note__id__documents_get","summary":"Retrieve Sales Credit Note Documents (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_112"}},"schemaId":"schema_112"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sales_credit_note~1{id}~1documents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_112","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_112"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/retrieve_sales_credit_note_documents__deprecated__v1_accounting_sales_credit_note__id__documents_get"}],"panels":[]}]},"httpPath":"/v1/accounting/sales_credit_note/{id}/documents"},{"label":"Report Refund Status For Sales Credit Note (Deprecated)","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/report_refund_status_for_sales_credit_note__deprecated__v1_accounting_sales_credit_note__id__refund_update_status_post","routeSlug":"/docs/api-accounting/report_refund_status_for_sales_credit_note__deprecated__v1_accounting_sales_credit_note__id__refund_update_status_post","metadata":{"seo":{"title":"Report Refund Status For Sales Credit Note (Deprecated)","description":"(deprecated, use /sales-credit-note/{id}/refund/update-status instead)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Report_refund_status_for_sales_credit_note__deprecated__v1_accounting_sales_credit_note__id__refund_update_status_post","name":"Report Refund Status For Sales Credit Note (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sales_credit_note~1{id}~1refund~1update-status/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Report Refund Status For Sales Credit Note (Deprecated)","isWebhook":false,"deprecated":true,"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":"(deprecated, use /sales-credit-note/{id}/refund/update-status instead)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1sales_credit_note~1{id}~1refund~1update-status/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RefundStatusUpdate"}},"schemaId":"components/schemas/RefundStatusUpdate","pointer":"/paths/~1v1~1accounting~1sales_credit_note~1{id}~1refund~1update-status/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/accounting/sales_credit_note/{id}/refund/update-status","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RefundStatusUpdate"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sales_credit_note/{id}/refund/update-status","href":"api-accounting/report_refund_status_for_sales_credit_note__deprecated__v1_accounting_sales_credit_note__id__refund_update_status_post","openApiOperationId":"Report_refund_status_for_sales_credit_note__deprecated__v1_accounting_sales_credit_note__id__refund_update_status_post","summary":"Report Refund Status For Sales Credit Note (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/RefundStatusUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RefundStatusUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RefundStatusUpdate"}},"schemaId":"components/schemas/RefundStatusUpdate"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sales_credit_note~1{id}~1refund~1update-status/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RefundStatusUpdate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RefundStatusUpdate"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/report_refund_status_for_sales_credit_note__deprecated__v1_accounting_sales_credit_note__id__refund_update_status_post"}],"panels":[]}]},"httpPath":"/v1/accounting/sales_credit_note/{id}/refund/update-status"},{"label":"Report Refund Status For Sales Credit Note (Deprecated)","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/report_refund_status_for_sales_credit_note__deprecated__v1_accounting_sales_credit_note__id__refund_update_status_post","routeSlug":"/docs/api-accounting/report_refund_status_for_sales_credit_note__deprecated__v1_accounting_sales_credit_note__id__refund_update_status_post","metadata":{"seo":{"title":"Report Refund Status For Sales Credit Note (Deprecated)","description":"(deprecated, use /sales-credit-note/{id}/refund/update-status instead)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Report_refund_status_for_sales_credit_note__deprecated__v1_accounting_sales_credit_note__id__refund_update_status_post","name":"Report Refund Status For Sales Credit Note (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sales_credit_note~1{id}~1refund~1update-status/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Report Refund Status For Sales Credit Note (Deprecated)","isWebhook":false,"deprecated":true,"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":"(deprecated, use /sales-credit-note/{id}/refund/update-status instead)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1sales_credit_note~1{id}~1refund~1update-status/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RefundStatusUpdate"}},"schemaId":"components/schemas/RefundStatusUpdate","pointer":"/paths/~1v1~1accounting~1sales_credit_note~1{id}~1refund~1update-status/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/accounting/sales_credit_note/{id}/refund/update-status","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RefundStatusUpdate"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sales_credit_note/{id}/refund/update-status","href":"api-accounting/report_refund_status_for_sales_credit_note__deprecated__v1_accounting_sales_credit_note__id__refund_update_status_post","openApiOperationId":"Report_refund_status_for_sales_credit_note__deprecated__v1_accounting_sales_credit_note__id__refund_update_status_post","summary":"Report Refund Status For Sales Credit Note (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/RefundStatusUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RefundStatusUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RefundStatusUpdate"}},"schemaId":"components/schemas/RefundStatusUpdate"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sales_credit_note~1{id}~1refund~1update-status/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RefundStatusUpdate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RefundStatusUpdate"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/report_refund_status_for_sales_credit_note__deprecated__v1_accounting_sales_credit_note__id__refund_update_status_post"}],"panels":[]}]},"httpPath":"/v1/accounting/sales_credit_note/{id}/refund/update-status"},{"label":"Retrieve Sales Invoice (Deprecated)","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/retrieve_sales_invoice__deprecated__v1_accounting_sales_invoice__id__get","routeSlug":"/docs/api-accounting/retrieve_sales_invoice__deprecated__v1_accounting_sales_invoice__id__get","metadata":{"seo":{"title":"Retrieve Sales Invoice (Deprecated)","description":"(deprecated, use /sales-invoice/{id} instead)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Retrieve_sales_invoice__deprecated__v1_accounting_sales_invoice__id__get","name":"Retrieve Sales Invoice (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sales_invoice~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Sales Invoice (Deprecated)","isWebhook":false,"deprecated":true,"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":"(deprecated, use /sales-invoice/{id} instead)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1sales_invoice~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/sales_invoice/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sales_invoice/{id}","href":"api-accounting/retrieve_sales_invoice__deprecated__v1_accounting_sales_invoice__id__get","openApiOperationId":"Retrieve_sales_invoice__deprecated__v1_accounting_sales_invoice__id__get","summary":"Retrieve Sales Invoice (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SalesInvoiceOutput"}},"schemaId":"components/schemas/SalesInvoiceOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sales_invoice~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SalesInvoiceOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SalesInvoiceOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/retrieve_sales_invoice__deprecated__v1_accounting_sales_invoice__id__get"}],"panels":[]}]},"httpPath":"/v1/accounting/sales_invoice/{id}"},{"label":"Retrieve Sales Invoice (Deprecated)","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/retrieve_sales_invoice__deprecated__v1_accounting_sales_invoice__id__get","routeSlug":"/docs/api-accounting/retrieve_sales_invoice__deprecated__v1_accounting_sales_invoice__id__get","metadata":{"seo":{"title":"Retrieve Sales Invoice (Deprecated)","description":"(deprecated, use /sales-invoice/{id} instead)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Retrieve_sales_invoice__deprecated__v1_accounting_sales_invoice__id__get","name":"Retrieve Sales Invoice (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sales_invoice~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Sales Invoice (Deprecated)","isWebhook":false,"deprecated":true,"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":"(deprecated, use /sales-invoice/{id} instead)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1sales_invoice~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/sales_invoice/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sales_invoice/{id}","href":"api-accounting/retrieve_sales_invoice__deprecated__v1_accounting_sales_invoice__id__get","openApiOperationId":"Retrieve_sales_invoice__deprecated__v1_accounting_sales_invoice__id__get","summary":"Retrieve Sales Invoice (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SalesInvoiceOutput"}},"schemaId":"components/schemas/SalesInvoiceOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sales_invoice~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SalesInvoiceOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SalesInvoiceOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/retrieve_sales_invoice__deprecated__v1_accounting_sales_invoice__id__get"}],"panels":[]}]},"httpPath":"/v1/accounting/sales_invoice/{id}"},{"label":"Update Sales Invoice (Deprecated)","deprecated":true,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/update_sales_invoice__deprecated__v1_accounting_sales_invoice__id__patch","routeSlug":"/docs/api-accounting/update_sales_invoice__deprecated__v1_accounting_sales_invoice__id__patch","metadata":{"seo":{"title":"Update Sales Invoice (Deprecated)","description":"(deprecated, use /sales-invoice/{id} instead)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update_sales_invoice__deprecated__v1_accounting_sales_invoice__id__patch","name":"Update Sales Invoice (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sales_invoice~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Sales Invoice (Deprecated)","isWebhook":false,"deprecated":true,"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":"(deprecated, use /sales-invoice/{id} instead)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1sales_invoice~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SalesInvoicePatchInput"}},"schemaId":"components/schemas/SalesInvoicePatchInput","pointer":"/paths/~1v1~1accounting~1sales_invoice~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/accounting/sales_invoice/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SalesInvoicePatchInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sales_invoice/{id}","href":"api-accounting/update_sales_invoice__deprecated__v1_accounting_sales_invoice__id__patch","openApiOperationId":"Update_sales_invoice__deprecated__v1_accounting_sales_invoice__id__patch","summary":"Update Sales Invoice (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/SalesInvoicePatchInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SalesInvoicePatchInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SalesInvoiceOutput"}},"schemaId":"components/schemas/SalesInvoiceOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sales_invoice~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SalesInvoiceOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SalesInvoiceOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/update_sales_invoice__deprecated__v1_accounting_sales_invoice__id__patch"}],"panels":[]}]},"httpPath":"/v1/accounting/sales_invoice/{id}"},{"label":"Update Sales Invoice (Deprecated)","deprecated":true,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/update_sales_invoice__deprecated__v1_accounting_sales_invoice__id__patch","routeSlug":"/docs/api-accounting/update_sales_invoice__deprecated__v1_accounting_sales_invoice__id__patch","metadata":{"seo":{"title":"Update Sales Invoice (Deprecated)","description":"(deprecated, use /sales-invoice/{id} instead)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update_sales_invoice__deprecated__v1_accounting_sales_invoice__id__patch","name":"Update Sales Invoice (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sales_invoice~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Sales Invoice (Deprecated)","isWebhook":false,"deprecated":true,"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":"(deprecated, use /sales-invoice/{id} instead)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1sales_invoice~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SalesInvoicePatchInput"}},"schemaId":"components/schemas/SalesInvoicePatchInput","pointer":"/paths/~1v1~1accounting~1sales_invoice~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/accounting/sales_invoice/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SalesInvoicePatchInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sales_invoice/{id}","href":"api-accounting/update_sales_invoice__deprecated__v1_accounting_sales_invoice__id__patch","openApiOperationId":"Update_sales_invoice__deprecated__v1_accounting_sales_invoice__id__patch","summary":"Update Sales Invoice (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/SalesInvoicePatchInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SalesInvoicePatchInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SalesInvoiceOutput"}},"schemaId":"components/schemas/SalesInvoiceOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sales_invoice~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SalesInvoiceOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SalesInvoiceOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/update_sales_invoice__deprecated__v1_accounting_sales_invoice__id__patch"}],"panels":[]}]},"httpPath":"/v1/accounting/sales_invoice/{id}"},{"label":"Retrieve Sales Invoice Documents (Deprecated)","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/retrieve_sales_invoice_documents__deprecated__v1_accounting_sales_invoice__id__documents_get","routeSlug":"/docs/api-accounting/retrieve_sales_invoice_documents__deprecated__v1_accounting_sales_invoice__id__documents_get","metadata":{"seo":{"title":"Retrieve Sales Invoice Documents (Deprecated)","description":"(deprecated, use /sales-invoice/{id}/documents instead)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Retrieve_sales_invoice_documents__deprecated__v1_accounting_sales_invoice__id__documents_get","name":"Retrieve Sales Invoice Documents (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sales_invoice~1{id}~1documents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Sales Invoice Documents (Deprecated)","isWebhook":false,"deprecated":true,"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":"(deprecated, use /sales-invoice/{id}/documents instead)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1sales_invoice~1{id}~1documents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/sales_invoice/{id}/documents","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sales_invoice/{id}/documents","href":"api-accounting/retrieve_sales_invoice_documents__deprecated__v1_accounting_sales_invoice__id__documents_get","openApiOperationId":"Retrieve_sales_invoice_documents__deprecated__v1_accounting_sales_invoice__id__documents_get","summary":"Retrieve Sales Invoice Documents (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_113"}},"schemaId":"schema_113"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sales_invoice~1{id}~1documents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_113","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_113"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/retrieve_sales_invoice_documents__deprecated__v1_accounting_sales_invoice__id__documents_get"}],"panels":[]}]},"httpPath":"/v1/accounting/sales_invoice/{id}/documents"},{"label":"Retrieve Sales Invoice Documents (Deprecated)","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/retrieve_sales_invoice_documents__deprecated__v1_accounting_sales_invoice__id__documents_get","routeSlug":"/docs/api-accounting/retrieve_sales_invoice_documents__deprecated__v1_accounting_sales_invoice__id__documents_get","metadata":{"seo":{"title":"Retrieve Sales Invoice Documents (Deprecated)","description":"(deprecated, use /sales-invoice/{id}/documents instead)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Retrieve_sales_invoice_documents__deprecated__v1_accounting_sales_invoice__id__documents_get","name":"Retrieve Sales Invoice Documents (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sales_invoice~1{id}~1documents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Sales Invoice Documents (Deprecated)","isWebhook":false,"deprecated":true,"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":"(deprecated, use /sales-invoice/{id}/documents instead)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1sales_invoice~1{id}~1documents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounting/sales_invoice/{id}/documents","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sales_invoice/{id}/documents","href":"api-accounting/retrieve_sales_invoice_documents__deprecated__v1_accounting_sales_invoice__id__documents_get","openApiOperationId":"Retrieve_sales_invoice_documents__deprecated__v1_accounting_sales_invoice__id__documents_get","summary":"Retrieve Sales Invoice Documents (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_113"}},"schemaId":"schema_113"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sales_invoice~1{id}~1documents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_113","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_113"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/retrieve_sales_invoice_documents__deprecated__v1_accounting_sales_invoice__id__documents_get"}],"panels":[]}]},"httpPath":"/v1/accounting/sales_invoice/{id}/documents"},{"label":"Report Payment Status For Sales Invoice (Deprecated)","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/report_payment_status_for_sales_invoice__deprecated__v1_accounting_sales_invoice__id__payment_update_status_post","routeSlug":"/docs/api-accounting/report_payment_status_for_sales_invoice__deprecated__v1_accounting_sales_invoice__id__payment_update_status_post","metadata":{"seo":{"title":"Report Payment Status For Sales Invoice (Deprecated)","description":"(deprecated, use /sales-invoice/{id}/payment/update-status instead)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Report_payment_status_for_sales_invoice__deprecated__v1_accounting_sales_invoice__id__payment_update_status_post","name":"Report Payment Status For Sales Invoice (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sales_invoice~1{id}~1payment~1update-status/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Report Payment Status For Sales Invoice (Deprecated)","isWebhook":false,"deprecated":true,"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":"(deprecated, use /sales-invoice/{id}/payment/update-status instead)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1sales_invoice~1{id}~1payment~1update-status/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}},"schemaId":"components/schemas/PaymentStatusUpdate","pointer":"/paths/~1v1~1accounting~1sales_invoice~1{id}~1payment~1update-status/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/accounting/sales_invoice/{id}/payment/update-status","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sales_invoice/{id}/payment/update-status","href":"api-accounting/report_payment_status_for_sales_invoice__deprecated__v1_accounting_sales_invoice__id__payment_update_status_post","openApiOperationId":"Report_payment_status_for_sales_invoice__deprecated__v1_accounting_sales_invoice__id__payment_update_status_post","summary":"Report Payment Status For Sales Invoice (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/PaymentStatusUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}},"schemaId":"components/schemas/PaymentStatusUpdate"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sales_invoice~1{id}~1payment~1update-status/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentStatusUpdate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/report_payment_status_for_sales_invoice__deprecated__v1_accounting_sales_invoice__id__payment_update_status_post"}],"panels":[]}]},"httpPath":"/v1/accounting/sales_invoice/{id}/payment/update-status"},{"label":"Report Payment Status For Sales Invoice (Deprecated)","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-accounting/report_payment_status_for_sales_invoice__deprecated__v1_accounting_sales_invoice__id__payment_update_status_post","routeSlug":"/docs/api-accounting/report_payment_status_for_sales_invoice__deprecated__v1_accounting_sales_invoice__id__payment_update_status_post","metadata":{"seo":{"title":"Report Payment Status For Sales Invoice (Deprecated)","description":"(deprecated, use /sales-invoice/{id}/payment/update-status instead)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Report_payment_status_for_sales_invoice__deprecated__v1_accounting_sales_invoice__id__payment_update_status_post","name":"Report Payment Status For Sales Invoice (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1accounting~1sales_invoice~1{id}~1payment~1update-status/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Report Payment Status For Sales Invoice (Deprecated)","isWebhook":false,"deprecated":true,"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":"(deprecated, use /sales-invoice/{id}/payment/update-status instead)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1accounting~1sales_invoice~1{id}~1payment~1update-status/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}},"schemaId":"components/schemas/PaymentStatusUpdate","pointer":"/paths/~1v1~1accounting~1sales_invoice~1{id}~1payment~1update-status/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/accounting/sales_invoice/{id}/payment/update-status","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/accounting/sales_invoice/{id}/payment/update-status","href":"api-accounting/report_payment_status_for_sales_invoice__deprecated__v1_accounting_sales_invoice__id__payment_update_status_post","openApiOperationId":"Report_payment_status_for_sales_invoice__deprecated__v1_accounting_sales_invoice__id__payment_update_status_post","summary":"Report Payment Status For Sales Invoice (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/PaymentStatusUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}},"schemaId":"components/schemas/PaymentStatusUpdate"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounting~1sales_invoice~1{id}~1payment~1update-status/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentStatusUpdate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentStatusUpdate"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-accounting/report_payment_status_for_sales_invoice__deprecated__v1_accounting_sales_invoice__id__payment_update_status_post"}],"panels":[]}]},"httpPath":"/v1/accounting/sales_invoice/{id}/payment/update-status"}],"content":{"contentType":"group","meta":{"name":"API / Accounting"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"API / Accounting","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/accounting/accounts","summary":"List Accounts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-accounting/list_accounts_v1_accounting_accounts_get","deprecated":false},{"title":"/v1/accounting/accounts/{id}","summary":"Retrieve Account","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-accounting/retrieve_account_v1_accounting_accounts__id__get","deprecated":false},{"title":"/v1/accounting/exchange-rate","summary":"Create An Exchange Rate","prefix":{"name":"post","color":"post"},"badges":[],"link":"/api-accounting/create_an_exchange_rate_v1_accounting_exchange_rate_post","deprecated":false},{"title":"/v1/accounting/exchange-rate","summary":"List Exchange Rates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-accounting/list_exchange_rates_v1_accounting_exchange_rate_get","deprecated":false},{"title":"/v1/accounting/purchase-credit-note/{id}","summary":"Retrieve Purchase Credit Note","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-accounting/retrieve_purchase_credit_note_v1_accounting_purchase_credit_note__id__get","deprecated":false},{"title":"/v1/accounting/purchase-credit-note/{id}","summary":"Update Purchase Credit Note","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/api-accounting/update_purchase_credit_note_v1_accounting_purchase_credit_note__id__patch","deprecated":false},{"title":"/v1/accounting/purchase-credit-note/{id}/documents","summary":"Retrieve Purchase Credit Note Documents","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-accounting/retrieve_purchase_credit_note_documents_v1_accounting_purchase_credit_note__id__documents_get","deprecated":false},{"title":"/v1/accounting/purchase-credit-note/{id}/refund/update-status","summary":"Report Refund Status For Purchase Credit Note","prefix":{"name":"post","color":"post"},"badges":[],"link":"/api-accounting/report_refund_status_for_purchase_credit_note_v1_accounting_purchase_credit_note__id__refund_update_status_post","deprecated":false},{"title":"/v1/accounting/purchase-invoice/{id}","summary":"Retrieve Purchase Invoice","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-accounting/retrieve_purchase_invoice_v1_accounting_purchase_invoice__id__get","deprecated":false},{"title":"/v1/accounting/purchase-invoice/{id}","summary":"Update Purchase Invoice","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/api-accounting/update_purchase_invoice_v1_accounting_purchase_invoice__id__patch","deprecated":false},{"title":"/v1/accounting/purchase-invoice/{id}/documents","summary":"Retrieve Purchase Invoice Documents","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-accounting/retrieve_purchase_invoice_documents_v1_accounting_purchase_invoice__id__documents_get","deprecated":false},{"title":"/v1/accounting/purchase-invoice/{id}/payment/update-status","summary":"Report Payment Status For Purchase Invoice","prefix":{"name":"post","color":"post"},"badges":[],"link":"/api-accounting/report_payment_status_for_purchase_invoice_v1_accounting_purchase_invoice__id__payment_update_status_post","deprecated":false},{"title":"/v1/accounting/sales-credit-note/","summary":"Create A Sales Credit Note","prefix":{"name":"post","color":"post"},"badges":[],"link":"/api-accounting/create_a_sales_credit_note_v1_accounting_sales_credit_note__post","deprecated":false},{"title":"/v1/accounting/sales-credit-note/{id}","summary":"Retrieve Sales Credit Note","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-accounting/retrieve_sales_credit_note_v1_accounting_sales_credit_note__id__get","deprecated":false},{"title":"/v1/accounting/sales-credit-note/{id}","summary":"Update Credit Note","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/api-accounting/update_credit_note_v1_accounting_sales_credit_note__id__patch","deprecated":false},{"title":"/v1/accounting/sales-credit-note/{id}/documents","summary":"Retrieve Sales Credit Note Documents","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-accounting/retrieve_sales_credit_note_documents_v1_accounting_sales_credit_note__id__documents_get","deprecated":false},{"title":"/v1/accounting/sales-credit-note/{id}/refund/update-status","summary":"Report Refund Status For Sales Credit Note","prefix":{"name":"post","color":"post"},"badges":[],"link":"/api-accounting/report_refund_status_for_sales_credit_note_v1_accounting_sales_credit_note__id__refund_update_status_post","deprecated":false},{"title":"/v1/accounting/sales-invoice/","summary":"Create A Sales Invoice","prefix":{"name":"post","color":"post"},"badges":[],"link":"/api-accounting/create_a_sales_invoice_v1_accounting_sales_invoice__post","deprecated":false},{"title":"/v1/accounting/sales-invoice/{id}","summary":"Retrieve Sales Invoice","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-accounting/retrieve_sales_invoice_v1_accounting_sales_invoice__id__get","deprecated":false},{"title":"/v1/accounting/sales-invoice/{id}","summary":"Update Sales Invoice","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/api-accounting/update_sales_invoice_v1_accounting_sales_invoice__id__patch","deprecated":false},{"title":"/v1/accounting/sales-invoice/{id}/documents","summary":"Retrieve Sales Invoice Documents","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-accounting/retrieve_sales_invoice_documents_v1_accounting_sales_invoice__id__documents_get","deprecated":false},{"title":"/v1/accounting/sales-invoice/{id}/payment/update-status","summary":"Report Payment Status For Sales Invoice","prefix":{"name":"post","color":"post"},"badges":[],"link":"/api-accounting/report_payment_status_for_sales_invoice_v1_accounting_sales_invoice__id__payment_update_status_post","deprecated":false},{"title":"/v1/accounting/sync-tasks","summary":"List Invoices/Credit Notes To Sync","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-accounting/list_invoices_credit_notes_to_sync_v1_accounting_sync_tasks_get","deprecated":false},{"title":"/v1/accounting/sync-tasks/{id}","summary":"Get Details Of Invoice/Credit Note To Sync","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-accounting/get_details_of_invoice_credit_note_to_sync_v1_accounting_sync_tasks__id__get","deprecated":false},{"title":"/v1/accounting/sync-tasks/{id}/update-status","summary":"Report Sync Status For Invoice/Credit Note","prefix":{"name":"post","color":"post"},"badges":[],"link":"/api-accounting/report_sync_status_for_invoice_credit_note_v1_accounting_sync_tasks__id__update_status_post","deprecated":false},{"title":"/v1/accounting/tax-rates","summary":"List Tax Rates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-accounting/list_tax_rates_v1_accounting_tax_rates_get","deprecated":false},{"title":"/v1/accounting/tax-rates/{id}","summary":"Retrieve Tax Rate","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-accounting/retrieve_tax_rate_v1_accounting_tax_rates__id__get","deprecated":false},{"title":"/v1/accounting/company","summary":"List Companies (Deprecated)","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/api-accounting/list_companies__deprecated__v1_accounting_company_get","deprecated":true},{"title":"/v1/accounting/company","summary":"Create Company (Deprecated)","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/api-accounting/create_company__deprecated__v1_accounting_company_post","deprecated":true},{"title":"/v1/accounting/company/{id}","summary":"Get Company (Deprecated)","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/api-accounting/get_company__deprecated__v1_accounting_company__id__get","deprecated":true},{"title":"/v1/accounting/company/{id}","summary":"Update Company (Deprecated)","prefix":{"name":"put","color":"http-deprecated"},"badges":[],"link":"/api-accounting/update_company__deprecated__v1_accounting_company__id__put","deprecated":true},{"title":"/v1/accounting/company/{id}","summary":"Update Company (Deprecated)","prefix":{"name":"patch","color":"http-deprecated"},"badges":[],"link":"/api-accounting/update_company__deprecated__v1_accounting_company__id__patch","deprecated":true},{"title":"/v1/accounting/company/{id}","summary":"Archive Company (Deprecated)","prefix":{"name":"delete","color":"http-deprecated"},"badges":[],"link":"/api-accounting/archive_company__deprecated__v1_accounting_company__id__delete","deprecated":true},{"title":"/v1/accounting/purchase_invoice/{id}","summary":"Retrieve Purchase Invoice (Deprecated)","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/api-accounting/retrieve_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__get","deprecated":true},{"title":"/v1/accounting/purchase_invoice/{id}","summary":"Retrieve Purchase Invoice (Deprecated)","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/api-accounting/retrieve_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__get","deprecated":true},{"title":"/v1/accounting/purchase_invoice/{id}","summary":"Update Purchase Invoice (Deprecated)","prefix":{"name":"patch","color":"http-deprecated"},"badges":[],"link":"/api-accounting/update_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__patch","deprecated":true},{"title":"/v1/accounting/purchase_invoice/{id}","summary":"Update Purchase Invoice (Deprecated)","prefix":{"name":"patch","color":"http-deprecated"},"badges":[],"link":"/api-accounting/update_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__patch","deprecated":true},{"title":"/v1/accounting/purchase_invoice/{id}/documents","summary":"Retrieve Purchase Invoice Documents (Deprecated)","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/api-accounting/retrieve_purchase_invoice_documents__deprecated__v1_accounting_purchase_invoice__id__documents_get","deprecated":true},{"title":"/v1/accounting/purchase_invoice/{id}/documents","summary":"Retrieve Purchase Invoice Documents (Deprecated)","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/api-accounting/retrieve_purchase_invoice_documents__deprecated__v1_accounting_purchase_invoice__id__documents_get","deprecated":true},{"title":"/v1/accounting/purchase_invoice/{id}/payment/update-status","summary":"Report Payment Status For Purchase Invoice (Deprecated)","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/api-accounting/report_payment_status_for_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__payment_update_status_post","deprecated":true},{"title":"/v1/accounting/purchase_invoice/{id}/payment/update-status","summary":"Report Payment Status For Purchase Invoice (Deprecated)","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/api-accounting/report_payment_status_for_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__payment_update_status_post","deprecated":true},{"title":"/v1/accounting/sales_credit_note/{id}","summary":"Retrieve Sales Credit Note (Deprecated)","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/api-accounting/retrieve_sales_credit_note__deprecated__v1_accounting_sales_credit_note__id__get","deprecated":true},{"title":"/v1/accounting/sales_credit_note/{id}","summary":"Retrieve Sales Credit Note (Deprecated)","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/api-accounting/retrieve_sales_credit_note__deprecated__v1_accounting_sales_credit_note__id__get","deprecated":true},{"title":"/v1/accounting/sales_credit_note/{id}","summary":"Update Credit Note (Deprecated)","prefix":{"name":"patch","color":"http-deprecated"},"badges":[],"link":"/api-accounting/update_credit_note__deprecated__v1_accounting_sales_credit_note__id__patch","deprecated":true},{"title":"/v1/accounting/sales_credit_note/{id}","summary":"Update Credit Note (Deprecated)","prefix":{"name":"patch","color":"http-deprecated"},"badges":[],"link":"/api-accounting/update_credit_note__deprecated__v1_accounting_sales_credit_note__id__patch","deprecated":true},{"title":"/v1/accounting/sales_credit_note/{id}/documents","summary":"Retrieve Sales Credit Note Documents (Deprecated)","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/api-accounting/retrieve_sales_credit_note_documents__deprecated__v1_accounting_sales_credit_note__id__documents_get","deprecated":true},{"title":"/v1/accounting/sales_credit_note/{id}/documents","summary":"Retrieve Sales Credit Note Documents (Deprecated)","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/api-accounting/retrieve_sales_credit_note_documents__deprecated__v1_accounting_sales_credit_note__id__documents_get","deprecated":true},{"title":"/v1/accounting/sales_credit_note/{id}/refund/update-status","summary":"Report Refund Status For Sales Credit Note (Deprecated)","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/api-accounting/report_refund_status_for_sales_credit_note__deprecated__v1_accounting_sales_credit_note__id__refund_update_status_post","deprecated":true},{"title":"/v1/accounting/sales_credit_note/{id}/refund/update-status","summary":"Report Refund Status For Sales Credit Note (Deprecated)","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/api-accounting/report_refund_status_for_sales_credit_note__deprecated__v1_accounting_sales_credit_note__id__refund_update_status_post","deprecated":true},{"title":"/v1/accounting/sales_invoice/{id}","summary":"Retrieve Sales Invoice (Deprecated)","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/api-accounting/retrieve_sales_invoice__deprecated__v1_accounting_sales_invoice__id__get","deprecated":true},{"title":"/v1/accounting/sales_invoice/{id}","summary":"Retrieve Sales Invoice (Deprecated)","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/api-accounting/retrieve_sales_invoice__deprecated__v1_accounting_sales_invoice__id__get","deprecated":true},{"title":"/v1/accounting/sales_invoice/{id}","summary":"Update Sales Invoice (Deprecated)","prefix":{"name":"patch","color":"http-deprecated"},"badges":[],"link":"/api-accounting/update_sales_invoice__deprecated__v1_accounting_sales_invoice__id__patch","deprecated":true},{"title":"/v1/accounting/sales_invoice/{id}","summary":"Update Sales Invoice (Deprecated)","prefix":{"name":"patch","color":"http-deprecated"},"badges":[],"link":"/api-accounting/update_sales_invoice__deprecated__v1_accounting_sales_invoice__id__patch","deprecated":true},{"title":"/v1/accounting/sales_invoice/{id}/documents","summary":"Retrieve Sales Invoice Documents (Deprecated)","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/api-accounting/retrieve_sales_invoice_documents__deprecated__v1_accounting_sales_invoice__id__documents_get","deprecated":true},{"title":"/v1/accounting/sales_invoice/{id}/documents","summary":"Retrieve Sales Invoice Documents (Deprecated)","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/api-accounting/retrieve_sales_invoice_documents__deprecated__v1_accounting_sales_invoice__id__documents_get","deprecated":true},{"title":"/v1/accounting/sales_invoice/{id}/payment/update-status","summary":"Report Payment Status For Sales Invoice (Deprecated)","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/api-accounting/report_payment_status_for_sales_invoice__deprecated__v1_accounting_sales_invoice__id__payment_update_status_post","deprecated":true},{"title":"/v1/accounting/sales_invoice/{id}/payment/update-status","summary":"Report Payment Status For Sales Invoice (Deprecated)","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/api-accounting/report_payment_status_for_sales_invoice__deprecated__v1_accounting_sales_invoice__id__payment_update_status_post","deprecated":true}]}]}]}]}},{"type":"group","label":"API / Authentication","link":"/docs/api-authentication","routeSlug":"/docs/api-authentication","items":[{"label":"Generate Token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-authentication/generate_token_v1_auth_token_post","routeSlug":"/docs/api-authentication/generate_token_v1_auth_token_post","metadata":{"seo":{"title":"Generate Token","description":"Generate Token"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generate_token_v1_auth_token_post","name":"Generate Token","isWebhook":false,"pointer":"/paths/~1v1~1auth~1token/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate Token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/auth/token","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500","503"],"pointer":"/v1/auth/token","href":"api-authentication/generate_token_v1_auth_token_post","openApiOperationId":"generate_token_v1_auth_token_post","summary":"Generate Token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Token"}},"schemaId":"components/schemas/Token"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1auth~1token/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Token","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Token"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-authentication/generate_token_v1_auth_token_post"}],"panels":[]}]},"httpPath":"/v1/auth/token"}],"content":{"contentType":"group","meta":{"name":"API / Authentication"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"API / Authentication","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/auth/token","summary":"Generate Token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/api-authentication/generate_token_v1_auth_token_post","deprecated":false}]}]}]}]}},{"type":"group","label":"API / Company","link":"/docs/api-company","routeSlug":"/docs/api-company","items":[{"label":"List Companies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-company/list_companies_v1_companies_company_get","routeSlug":"/docs/api-company/list_companies_v1_companies_company_get","metadata":{"seo":{"title":"List Companies","description":"List Companies"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_companies_v1_companies_company_get","name":"List Companies","isWebhook":false,"pointer":"/paths/~1v1~1companies~1company/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Companies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_89","description":"Pagination cursor. Mutually exclusive with other query parameters"},{"name":"updated_after","in":"query","schemaId":"schema_108","description":"Filter to fetch the companies updated after this time. Format is ISO 8601 YYYY-MM-DDTHH:MM:SSZ"},{"name":"code","in":"query","schemaId":"schema_92","description":"Company code to match exactly."},{"name":"code:in","in":"query","schemaId":"schema_93","description":"Company codes to match. Comma-separated list."},{"name":"accounting_customer_code","in":"query","schemaId":"schema_109","description":"Accounting customer code to match exactly. Holds the code of the default billing entity."},{"name":"accounting_customer_code:in","in":"query","schemaId":"schema_110","description":"Accounting customer codes to match. Comma-separated list. Holds the code of the default billing entity."}],"pointer":"/paths/~1v1~1companies~1company/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/companies/company","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_89"},{"name":"updated_after","in":"query","required":false,"schemaId":"schema_108"},{"name":"code","in":"query","required":false,"schemaId":"schema_92"},{"name":"code:in","in":"query","required":false,"schemaId":"schema_93"},{"name":"accounting_customer_code","in":"query","required":false,"schemaId":"schema_109"},{"name":"accounting_customer_code:in","in":"query","required":false,"schemaId":"schema_110"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/companies/company","href":"api-company/list_companies_v1_companies_company_get","openApiOperationId":"list_companies_v1_companies_company_get","summary":"List Companies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCompanyOutput"}},"schemaId":"components/schemas/ListCompanyOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1companies~1company/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCompanyOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCompanyOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-company/list_companies_v1_companies_company_get"}],"panels":[]}]},"httpPath":"/v1/companies/company"},{"label":"Create Company","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-company/create_company_v1_companies_company_post","routeSlug":"/docs/api-company/create_company_v1_companies_company_post","metadata":{"seo":{"title":"Create Company","description":"Create Company"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_company_v1_companies_company_post","name":"Create Company","isWebhook":false,"pointer":"/paths/~1v1~1companies~1company/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Company","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyInput"}},"schemaId":"components/schemas/CompanyInput","pointer":"/paths/~1v1~1companies~1company/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/companies/company","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CompanyInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/companies/company","href":"api-company/create_company_v1_companies_company_post","openApiOperationId":"create_company_v1_companies_company_post","summary":"Create Company"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/CompanyInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyDetailOutput"}},"schemaId":"components/schemas/CompanyDetailOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1companies~1company/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompanyDetailOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyDetailOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-company/create_company_v1_companies_company_post"}],"panels":[]}]},"httpPath":"/v1/companies/company"},{"label":"Get Company Documents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-company/get_company_documents_v1_companies_company__company_id__documents_get","routeSlug":"/docs/api-company/get_company_documents_v1_companies_company__company_id__documents_get","metadata":{"seo":{"title":"Get Company Documents","description":"Fetch all documents for a specific company."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_company_documents_v1_companies_company__company_id__documents_get","name":"Get Company Documents","isWebhook":false,"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1documents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Company Documents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetch all documents for a specific company."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"company_id","in":"path","schemaId":"schema_133","required":true}],"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1documents/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_89","description":"Pagination cursor. Mutually exclusive with other query parameters"}],"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1documents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/companies/company/{company_id}/documents","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"company_id","in":"path","required":true,"schemaId":"schema_133"}],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_89"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/companies/company/{company_id}/documents","href":"api-company/get_company_documents_v1_companies_company__company_id__documents_get","openApiOperationId":"get_company_documents_v1_companies_company__company_id__documents_get","summary":"Get Company Documents"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCompanyDocumentOutput"}},"schemaId":"components/schemas/ListCompanyDocumentOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1documents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCompanyDocumentOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCompanyDocumentOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-company/get_company_documents_v1_companies_company__company_id__documents_get"}],"panels":[]}]},"httpPath":"/v1/companies/company/{company_id}/documents"},{"label":"Create Company Document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-company/create_company_document_v1_companies_company__company_id__documents_post","routeSlug":"/docs/api-company/create_company_document_v1_companies_company__company_id__documents_post","metadata":{"seo":{"title":"Create Company Document","description":"Upload a document for a specific company."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_company_document_v1_companies_company__company_id__documents_post","name":"Create Company Document","isWebhook":false,"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1documents/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Company Document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Upload a document for a specific company."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"company_id","in":"path","schemaId":"schema_133","required":true}],"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1documents/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UploadedCompanyDocumentWithValidity"}},"schemaId":"components/schemas/UploadedCompanyDocumentWithValidity","pointer":"/paths/~1v1~1companies~1company~1{company_id}~1documents/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/companies/company/{company_id}/documents","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"company_id","in":"path","required":true,"schemaId":"schema_133"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UploadedCompanyDocumentWithValidity"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/companies/company/{company_id}/documents","href":"api-company/create_company_document_v1_companies_company__company_id__documents_post","openApiOperationId":"create_company_document_v1_companies_company__company_id__documents_post","summary":"Create Company Document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/UploadedCompanyDocumentWithValidity","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UploadedCompanyDocumentWithValidity"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyDocumentOutput"}},"schemaId":"components/schemas/CompanyDocumentOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1documents/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompanyDocumentOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyDocumentOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-company/create_company_document_v1_companies_company__company_id__documents_post"}],"panels":[]}]},"httpPath":"/v1/companies/company/{company_id}/documents"},{"label":"List Company Validities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-company/list_company_validities_v1_companies_company__company_id__validity_get","routeSlug":"/docs/api-company/list_company_validities_v1_companies_company__company_id__validity_get","metadata":{"seo":{"title":"List Company Validities","description":"List all validities for a company."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"List_company_validities_v1_companies_company__company_id__validity_get","name":"List Company Validities","isWebhook":false,"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1validity/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Company Validities","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all validities for a company."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"company_id","in":"path","schemaId":"schema_133","required":true}],"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1validity/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_89","description":"Pagination cursor. Mutually exclusive with other query parameters"},{"name":"start_time","in":"query","schemaId":"schema_134","description":"Filter to fetch unavailabilities after this time"},{"name":"end_time","in":"query","schemaId":"schema_135","description":"Filter to fetch unavailabilities before this time"}],"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1validity/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/companies/company/{company_id}/validity","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"company_id","in":"path","required":true,"schemaId":"schema_133"}],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_89"},{"name":"start_time","in":"query","required":false,"schemaId":"schema_134"},{"name":"end_time","in":"query","required":false,"schemaId":"schema_135"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/companies/company/{company_id}/validity","href":"api-company/list_company_validities_v1_companies_company__company_id__validity_get","openApiOperationId":"List_company_validities_v1_companies_company__company_id__validity_get","summary":"List Company Validities"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCompanyValidityOutput"}},"schemaId":"components/schemas/ListCompanyValidityOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1validity/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCompanyValidityOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCompanyValidityOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-company/list_company_validities_v1_companies_company__company_id__validity_get"}],"panels":[]}]},"httpPath":"/v1/companies/company/{company_id}/validity"},{"label":"Create Company Validity Request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-company/create_company_validity_request_v1_companies_company__company_id__validity_post","routeSlug":"/docs/api-company/create_company_validity_request_v1_companies_company__company_id__validity_post","metadata":{"seo":{"title":"Create Company Validity Request","description":"Create a new validity request for a company."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create_company_validity_request_v1_companies_company__company_id__validity_post","name":"Create Company Validity Request","isWebhook":false,"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1validity/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Company Validity Request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new validity request for a company."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"company_id","in":"path","schemaId":"schema_133","required":true}],"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1validity/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyValidityInput"}},"schemaId":"components/schemas/CompanyValidityInput","pointer":"/paths/~1v1~1companies~1company~1{company_id}~1validity/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/companies/company/{company_id}/validity","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"company_id","in":"path","required":true,"schemaId":"schema_133"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CompanyValidityInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/companies/company/{company_id}/validity","href":"api-company/create_company_validity_request_v1_companies_company__company_id__validity_post","openApiOperationId":"Create_company_validity_request_v1_companies_company__company_id__validity_post","summary":"Create Company Validity Request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/CompanyValidityInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyValidityInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyValidityOutput"}},"schemaId":"components/schemas/CompanyValidityOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1validity/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompanyValidityOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyValidityOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-company/create_company_validity_request_v1_companies_company__company_id__validity_post"}],"panels":[]}]},"httpPath":"/v1/companies/company/{company_id}/validity"},{"label":"Get Company Validity","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-company/get_company_validity_v1_companies_company__company_id__validity__id__get","routeSlug":"/docs/api-company/get_company_validity_v1_companies_company__company_id__validity__id__get","metadata":{"seo":{"title":"Get Company Validity","description":"Fetches a specific validity for a company."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get_company_validity_v1_companies_company__company_id__validity__id__get","name":"Get Company Validity","isWebhook":false,"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1validity~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Company Validity","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches a specific validity for a company."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"company_id","in":"path","schemaId":"schema_133","required":true},{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1validity~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/companies/company/{company_id}/validity/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"company_id","in":"path","required":true,"schemaId":"schema_133"},{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/companies/company/{company_id}/validity/{id}","href":"api-company/get_company_validity_v1_companies_company__company_id__validity__id__get","openApiOperationId":"Get_company_validity_v1_companies_company__company_id__validity__id__get","summary":"Get Company Validity"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyValidityOutput"}},"schemaId":"components/schemas/CompanyValidityOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1validity~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompanyValidityOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyValidityOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-company/get_company_validity_v1_companies_company__company_id__validity__id__get"}],"panels":[]}]},"httpPath":"/v1/companies/company/{company_id}/validity/{id}"},{"label":"Update Company Validity","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-company/update_company_validity_v1_companies_company__company_id__validity__id__put","routeSlug":"/docs/api-company/update_company_validity_v1_companies_company__company_id__validity__id__put","metadata":{"seo":{"title":"Update Company Validity","description":"Update an existing validity for a company."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update_company_validity_v1_companies_company__company_id__validity__id__put","name":"Update Company Validity","isWebhook":false,"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1validity~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Company Validity","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update an existing validity for a company."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"company_id","in":"path","schemaId":"schema_133","required":true},{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1validity~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyValidityInput"}},"schemaId":"components/schemas/CompanyValidityInput","pointer":"/paths/~1v1~1companies~1company~1{company_id}~1validity~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/companies/company/{company_id}/validity/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"company_id","in":"path","required":true,"schemaId":"schema_133"},{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CompanyValidityInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/companies/company/{company_id}/validity/{id}","href":"api-company/update_company_validity_v1_companies_company__company_id__validity__id__put","openApiOperationId":"Update_company_validity_v1_companies_company__company_id__validity__id__put","summary":"Update Company Validity"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/CompanyValidityInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyValidityInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyValidityOutput"}},"schemaId":"components/schemas/CompanyValidityOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1validity~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompanyValidityOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyValidityOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-company/update_company_validity_v1_companies_company__company_id__validity__id__put"}],"panels":[]}]},"httpPath":"/v1/companies/company/{company_id}/validity/{id}"},{"label":"Delete Company Validity","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-company/delete_company_validity_v1_companies_company__company_id__validity__id__delete","routeSlug":"/docs/api-company/delete_company_validity_v1_companies_company__company_id__validity__id__delete","metadata":{"seo":{"title":"Delete Company Validity","description":"Delete a company validity."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete_company_validity_v1_companies_company__company_id__validity__id__delete","name":"Delete Company Validity","isWebhook":false,"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1validity~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Company Validity","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a company validity."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"company_id","in":"path","schemaId":"schema_133","required":true},{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1validity~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/companies/company/{company_id}/validity/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"company_id","in":"path","required":true,"schemaId":"schema_133"},{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["204","400","401","403","422","429","500","503"],"pointer":"/v1/companies/company/{company_id}/validity/{id}","href":"api-company/delete_company_validity_v1_companies_company__company_id__validity__id__delete","openApiOperationId":"Delete_company_validity_v1_companies_company__company_id__validity__id__delete","summary":"Delete Company Validity"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful Response"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1validity~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-company/delete_company_validity_v1_companies_company__company_id__validity__id__delete"}],"panels":[]}]},"httpPath":"/v1/companies/company/{company_id}/validity/{id}"},{"label":"Get Company Validity Documents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-company/get_company_validity_documents_v1_companies_company__company_id__validity__id__documents_get","routeSlug":"/docs/api-company/get_company_validity_documents_v1_companies_company__company_id__validity__id__documents_get","metadata":{"seo":{"title":"Get Company Validity Documents","description":"Fetch all documents associated with a specific company validity."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get_company_validity_documents_v1_companies_company__company_id__validity__id__documents_get","name":"Get Company Validity Documents","isWebhook":false,"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1validity~1{id}~1documents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Company Validity Documents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetch all documents associated with a specific company validity."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"company_id","in":"path","schemaId":"schema_133","required":true},{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1validity~1{id}~1documents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/companies/company/{company_id}/validity/{id}/documents","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"company_id","in":"path","required":true,"schemaId":"schema_133"},{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/companies/company/{company_id}/validity/{id}/documents","href":"api-company/get_company_validity_documents_v1_companies_company__company_id__validity__id__documents_get","openApiOperationId":"Get_company_validity_documents_v1_companies_company__company_id__validity__id__documents_get","summary":"Get Company Validity Documents"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_136"}},"schemaId":"schema_136"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1companies~1company~1{company_id}~1validity~1{id}~1documents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_136","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_136"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-company/get_company_validity_documents_v1_companies_company__company_id__validity__id__documents_get"}],"panels":[]}]},"httpPath":"/v1/companies/company/{company_id}/validity/{id}/documents"},{"label":"Get Company","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-company/get_company_v1_companies_company__id__get","routeSlug":"/docs/api-company/get_company_v1_companies_company__id__get","metadata":{"seo":{"title":"Get Company","description":"Get Company"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_company_v1_companies_company__id__get","name":"Get Company","isWebhook":false,"pointer":"/paths/~1v1~1companies~1company~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Company","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1companies~1company~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/companies/company/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/companies/company/{id}","href":"api-company/get_company_v1_companies_company__id__get","openApiOperationId":"get_company_v1_companies_company__id__get","summary":"Get Company"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyDetailOutput"}},"schemaId":"components/schemas/CompanyDetailOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1companies~1company~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompanyDetailOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyDetailOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-company/get_company_v1_companies_company__id__get"}],"panels":[]}]},"httpPath":"/v1/companies/company/{id}"},{"label":"Update Company","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-company/update_company_v1_companies_company__id__put","routeSlug":"/docs/api-company/update_company_v1_companies_company__id__put","metadata":{"seo":{"title":"Update Company","description":"Update Company"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_company_v1_companies_company__id__put","name":"Update Company","isWebhook":false,"pointer":"/paths/~1v1~1companies~1company~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Company","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1companies~1company~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyInput"}},"schemaId":"components/schemas/CompanyInput","pointer":"/paths/~1v1~1companies~1company~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/companies/company/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CompanyInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/companies/company/{id}","href":"api-company/update_company_v1_companies_company__id__put","openApiOperationId":"update_company_v1_companies_company__id__put","summary":"Update Company"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/CompanyInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyDetailOutput"}},"schemaId":"components/schemas/CompanyDetailOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1companies~1company~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompanyDetailOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyDetailOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-company/update_company_v1_companies_company__id__put"}],"panels":[]}]},"httpPath":"/v1/companies/company/{id}"},{"label":"Update Company","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-company/update_company_v1_companies_company__id__patch","routeSlug":"/docs/api-company/update_company_v1_companies_company__id__patch","metadata":{"seo":{"title":"Update Company","description":"Update Company"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_company_v1_companies_company__id__patch","name":"Update Company","isWebhook":false,"pointer":"/paths/~1v1~1companies~1company~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Company","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1companies~1company~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyPartialInput"}},"schemaId":"components/schemas/CompanyPartialInput","pointer":"/paths/~1v1~1companies~1company~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/companies/company/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CompanyPartialInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/companies/company/{id}","href":"api-company/update_company_v1_companies_company__id__patch","openApiOperationId":"update_company_v1_companies_company__id__patch","summary":"Update Company"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/CompanyPartialInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompanyPartialInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyDetailOutput"}},"schemaId":"components/schemas/CompanyDetailOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1companies~1company~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompanyDetailOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyDetailOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-company/update_company_v1_companies_company__id__patch"}],"panels":[]}]},"httpPath":"/v1/companies/company/{id}"},{"label":"Archive Company","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-company/archive_company_v1_companies_company__id__delete","routeSlug":"/docs/api-company/archive_company_v1_companies_company__id__delete","metadata":{"seo":{"title":"Archive Company","description":"Archive the company. This is a soft-delete: the company record is preserved and its archived_customer, archived_subcontractor, and archived_buyer_or_seller flags are set to true so it no longer appears in active lists."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Archive_company_v1_companies_company__id__delete","name":"Archive Company","isWebhook":false,"pointer":"/paths/~1v1~1companies~1company~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Archive Company","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":"Archive the company. This is a soft-delete: the company record is preserved and its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"archived_customer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"archived_subcontractor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"archived_buyer_or_seller"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flags are set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" so it no longer appears in active lists."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1companies~1company~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/companies/company/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["204","400","401","403","422","429","500","503"],"pointer":"/v1/companies/company/{id}","href":"api-company/archive_company_v1_companies_company__id__delete","openApiOperationId":"Archive_company_v1_companies_company__id__delete","summary":"Archive Company"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful Response"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1companies~1company~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-company/archive_company_v1_companies_company__id__delete"}],"panels":[]}]},"httpPath":"/v1/companies/company/{id}"}],"content":{"contentType":"group","meta":{"name":"API / Company"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"API / Company","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/companies/company","summary":"List Companies","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-company/list_companies_v1_companies_company_get","deprecated":false},{"title":"/v1/companies/company","summary":"Create Company","prefix":{"name":"post","color":"post"},"badges":[],"link":"/api-company/create_company_v1_companies_company_post","deprecated":false},{"title":"/v1/companies/company/{company_id}/documents","summary":"Get Company Documents","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-company/get_company_documents_v1_companies_company__company_id__documents_get","deprecated":false},{"title":"/v1/companies/company/{company_id}/documents","summary":"Create Company Document","prefix":{"name":"post","color":"post"},"badges":[],"link":"/api-company/create_company_document_v1_companies_company__company_id__documents_post","deprecated":false},{"title":"/v1/companies/company/{company_id}/validity","summary":"List Company Validities","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-company/list_company_validities_v1_companies_company__company_id__validity_get","deprecated":false},{"title":"/v1/companies/company/{company_id}/validity","summary":"Create Company Validity Request","prefix":{"name":"post","color":"post"},"badges":[],"link":"/api-company/create_company_validity_request_v1_companies_company__company_id__validity_post","deprecated":false},{"title":"/v1/companies/company/{company_id}/validity/{id}","summary":"Get Company Validity","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-company/get_company_validity_v1_companies_company__company_id__validity__id__get","deprecated":false},{"title":"/v1/companies/company/{company_id}/validity/{id}","summary":"Update Company Validity","prefix":{"name":"put","color":"put"},"badges":[],"link":"/api-company/update_company_validity_v1_companies_company__company_id__validity__id__put","deprecated":false},{"title":"/v1/companies/company/{company_id}/validity/{id}","summary":"Delete Company Validity","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/api-company/delete_company_validity_v1_companies_company__company_id__validity__id__delete","deprecated":false},{"title":"/v1/companies/company/{company_id}/validity/{id}/documents","summary":"Get Company Validity Documents","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-company/get_company_validity_documents_v1_companies_company__company_id__validity__id__documents_get","deprecated":false},{"title":"/v1/companies/company/{id}","summary":"Get Company","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-company/get_company_v1_companies_company__id__get","deprecated":false},{"title":"/v1/companies/company/{id}","summary":"Update Company","prefix":{"name":"put","color":"put"},"badges":[],"link":"/api-company/update_company_v1_companies_company__id__put","deprecated":false},{"title":"/v1/companies/company/{id}","summary":"Update Company","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/api-company/update_company_v1_companies_company__id__patch","deprecated":false},{"title":"/v1/companies/company/{id}","summary":"Archive Company","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/api-company/archive_company_v1_companies_company__id__delete","deprecated":false}]}]}]}]}},{"type":"group","label":"API / Document","link":"/docs/api-document","routeSlug":"/docs/api-document","items":[{"label":"Download Document","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-document/download_document_v1_documents_document__id__download_get","routeSlug":"/docs/api-document/download_document_v1_documents_document__id__download_get","metadata":{"seo":{"title":"Download Document","description":"Download a document by its ID. You can choose to download the document directly or stream it."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"download_document_v1_documents_document__id__download_get","name":"Download Document","isWebhook":false,"pointer":"/paths/~1v1~1documents~1document~1{id}~1download/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download Document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Download a document by its ID. You can choose to download the document directly or stream it."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1documents~1document~1{id}~1download/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"direct","in":"query","schemaId":"schema_105","description":"Query parameter to indicate that the response should contain all the document bytes"}],"pointer":"/paths/~1v1~1documents~1document~1{id}~1download/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/documents/document/{id}/download","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[{"name":"direct","in":"query","required":false,"schemaId":"schema_105"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/documents/document/{id}/download","href":"api-document/download_document_v1_documents_document__id__download_get","openApiOperationId":"download_document_v1_documents_document__id__download_get","summary":"Download Document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}},"schemaId":"schema_106"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1documents~1document~1{id}~1download/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_106","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-document/download_document_v1_documents_document__id__download_get"}],"panels":[]}]},"httpPath":"/v1/documents/document/{id}/download"},{"label":"Upload Document Content","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-document/upload_document_content_v1_documents_document_upload_content_post","routeSlug":"/docs/api-document/upload_document_content_v1_documents_document_upload_content_post","metadata":{"seo":{"title":"Upload Document Content","description":"Upload document content."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Upload_document_content_v1_documents_document_upload_content_post","name":"Upload Document Content","isWebhook":false,"pointer":"/paths/~1v1~1documents~1document~1upload_content/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload Document Content","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Upload document content."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/Body_Upload_document_content_v1_documents_document_upload_content_post"}},"schemaId":"components/schemas/Body_Upload_document_content_v1_documents_document_upload_content_post","pointer":"/paths/~1v1~1documents~1document~1upload_content/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/documents/document/upload_content","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/Body_Upload_document_content_v1_documents_document_upload_content_post"}},"responseCodes":["201","400","401","403","422","429","500","503"],"pointer":"/v1/documents/document/upload_content","href":"api-document/upload_document_content_v1_documents_document_upload_content_post","openApiOperationId":"Upload_document_content_v1_documents_document_upload_content_post","summary":"Upload Document Content"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/Body_Upload_document_content_v1_documents_document_upload_content_post","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/Body_Upload_document_content_v1_documents_document_upload_content_post"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentUploadResponse"}},"schemaId":"components/schemas/DocumentUploadResponse"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1documents~1document~1upload_content/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/DocumentUploadResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentUploadResponse"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-document/upload_document_content_v1_documents_document_upload_content_post"}],"panels":[]}]},"httpPath":"/v1/documents/document/upload_content"}],"content":{"contentType":"group","meta":{"name":"API / Document"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"API / Document","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/documents/document/{id}/download","summary":"Download Document","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-document/download_document_v1_documents_document__id__download_get","deprecated":false},{"title":"/v1/documents/document/upload_content","summary":"Upload Document Content","prefix":{"name":"post","color":"post"},"badges":[],"link":"/api-document/upload_document_content_v1_documents_document_upload_content_post","deprecated":false}]}]}]}]}},{"type":"group","label":"API / Location","link":"/docs/api-location","routeSlug":"/docs/api-location","items":[{"label":"Create Location","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-location/create_location_v1_locations_location_post","routeSlug":"/docs/api-location/create_location_v1_locations_location_post","metadata":{"seo":{"title":"Create Location","description":"Create a new location."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create_location_v1_locations_location_post","name":"Create Location","isWebhook":false,"pointer":"/paths/~1v1~1locations~1location/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Location","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new location."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LocationDetailInput"}},"schemaId":"components/schemas/LocationDetailInput","pointer":"/paths/~1v1~1locations~1location/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/locations/location","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LocationDetailInput"}},"responseCodes":["201","400","401","403","422","429","500","503"],"pointer":"/v1/locations/location","href":"api-location/create_location_v1_locations_location_post","openApiOperationId":"Create_location_v1_locations_location_post","summary":"Create Location"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/LocationDetailInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LocationDetailInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LocationDetailOutput"}},"schemaId":"components/schemas/LocationDetailOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1locations~1location/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/LocationDetailOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LocationDetailOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-location/create_location_v1_locations_location_post"}],"panels":[]}]},"httpPath":"/v1/locations/location"},{"label":"List Locations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-location/list_locations_v1_locations_location_get","routeSlug":"/docs/api-location/list_locations_v1_locations_location_get","metadata":{"seo":{"title":"List Locations","description":"List all locations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"List_locations_v1_locations_location_get","name":"List Locations","isWebhook":false,"pointer":"/paths/~1v1~1locations~1location/get","hasSamples":false},"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":"List all locations."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_89","description":"Pagination cursor. Mutually exclusive with other query parameters"},{"name":"external_id","in":"query","schemaId":"schema_137","description":"External location identifier to match exactly."},{"name":"external_id:in","in":"query","schemaId":"schema_138","description":"External location identifiers to match. Comma-separated list."}],"pointer":"/paths/~1v1~1locations~1location/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/locations/location","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_89"},{"name":"external_id","in":"query","required":false,"schemaId":"schema_137"},{"name":"external_id:in","in":"query","required":false,"schemaId":"schema_138"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/locations/location","href":"api-location/list_locations_v1_locations_location_get","openApiOperationId":"List_locations_v1_locations_location_get","summary":"List Locations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListLocationOutput"}},"schemaId":"components/schemas/ListLocationOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1locations~1location/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListLocationOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListLocationOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-location/list_locations_v1_locations_location_get"}],"panels":[]}]},"httpPath":"/v1/locations/location"},{"label":"Update Location","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-location/update_location_v1_locations_location__location_id__put","routeSlug":"/docs/api-location/update_location_v1_locations_location__location_id__put","metadata":{"seo":{"title":"Update Location","description":"Update an existing location. An update that moves the coordinates far from the current position creates and returns a new location, leaving already existing orders on the original one."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update_location_v1_locations_location__location_id__put","name":"Update Location","isWebhook":false,"pointer":"/paths/~1v1~1locations~1location~1{location_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Location","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update an existing location. An update that moves the coordinates far from the current position creates and returns a new location, leaving already existing orders on the original one."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_139","required":true}],"pointer":"/paths/~1v1~1locations~1location~1{location_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LocationDetailInput"}},"schemaId":"components/schemas/LocationDetailInput","pointer":"/paths/~1v1~1locations~1location~1{location_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/locations/location/{location_id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_139"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LocationDetailInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/locations/location/{location_id}","href":"api-location/update_location_v1_locations_location__location_id__put","openApiOperationId":"Update_location_v1_locations_location__location_id__put","summary":"Update Location"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/LocationDetailInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LocationDetailInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LocationDetailOutput"}},"schemaId":"components/schemas/LocationDetailOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1locations~1location~1{location_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/LocationDetailOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LocationDetailOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-location/update_location_v1_locations_location__location_id__put"}],"panels":[]}]},"httpPath":"/v1/locations/location/{location_id}"},{"label":"Patch Location","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-location/patch_location_v1_locations_location__location_id__patch","routeSlug":"/docs/api-location/patch_location_v1_locations_location__location_id__patch","metadata":{"seo":{"title":"Patch Location","description":"Partially update an existing location. An update that moves the coordinates far from the current position creates and returns a new location, leaving already existing orders on the original one."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Patch_location_v1_locations_location__location_id__patch","name":"Patch Location","isWebhook":false,"pointer":"/paths/~1v1~1locations~1location~1{location_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch Location","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Partially update an existing location. An update that moves the coordinates far from the current position creates and returns a new location, leaving already existing orders on the original one."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_139","required":true}],"pointer":"/paths/~1v1~1locations~1location~1{location_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PartialLocationDetailInput"}},"schemaId":"components/schemas/PartialLocationDetailInput","pointer":"/paths/~1v1~1locations~1location~1{location_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/locations/location/{location_id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_139"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PartialLocationDetailInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/locations/location/{location_id}","href":"api-location/patch_location_v1_locations_location__location_id__patch","openApiOperationId":"Patch_location_v1_locations_location__location_id__patch","summary":"Patch Location"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/PartialLocationDetailInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PartialLocationDetailInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LocationDetailOutput"}},"schemaId":"components/schemas/LocationDetailOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1locations~1location~1{location_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/LocationDetailOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LocationDetailOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-location/patch_location_v1_locations_location__location_id__patch"}],"panels":[]}]},"httpPath":"/v1/locations/location/{location_id}"},{"label":"Get Location","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-location/get_location_v1_locations_location__location_id__get","routeSlug":"/docs/api-location/get_location_v1_locations_location__location_id__get","metadata":{"seo":{"title":"Get Location","description":"Fetches a location."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get_location_v1_locations_location__location_id__get","name":"Get Location","isWebhook":false,"pointer":"/paths/~1v1~1locations~1location~1{location_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Location","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches a location."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_139","required":true}],"pointer":"/paths/~1v1~1locations~1location~1{location_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/locations/location/{location_id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_139"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/locations/location/{location_id}","href":"api-location/get_location_v1_locations_location__location_id__get","openApiOperationId":"Get_location_v1_locations_location__location_id__get","summary":"Get Location"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LocationDetailOutput"}},"schemaId":"components/schemas/LocationDetailOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1locations~1location~1{location_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/LocationDetailOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LocationDetailOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-location/get_location_v1_locations_location__location_id__get"}],"panels":[]}]},"httpPath":"/v1/locations/location/{location_id}"}],"content":{"contentType":"group","meta":{"name":"API / Location"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"API / Location","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/locations/location","summary":"Create Location","prefix":{"name":"post","color":"post"},"badges":[],"link":"/api-location/create_location_v1_locations_location_post","deprecated":false},{"title":"/v1/locations/location","summary":"List Locations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-location/list_locations_v1_locations_location_get","deprecated":false},{"title":"/v1/locations/location/{location_id}","summary":"Update Location","prefix":{"name":"put","color":"put"},"badges":[],"link":"/api-location/update_location_v1_locations_location__location_id__put","deprecated":false},{"title":"/v1/locations/location/{location_id}","summary":"Patch Location","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/api-location/patch_location_v1_locations_location__location_id__patch","deprecated":false},{"title":"/v1/locations/location/{location_id}","summary":"Get Location","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-location/get_location_v1_locations_location__location_id__get","deprecated":false}]}]}]}]}},{"type":"group","label":"API / Order","link":"/docs/api-order","routeSlug":"/docs/api-order","items":[{"label":"Import Order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-order/import_order_v1_orders_order_upload_post","routeSlug":"/docs/api-order/import_order_v1_orders_order_upload_post","metadata":{"seo":{"title":"Import Order","description":"Create or update orders in Qargo. See the \"Transport order creation & status\" section for more info."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"import_order_v1_orders_order_upload_post","name":"Import Order","isWebhook":false,"pointer":"/paths/~1v1~1orders~1order~1upload/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Import Order","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":"Create or update orders in Qargo. See the \"Transport order creation & status\" section for more info."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderInput"}},"schemaId":"components/schemas/OrderInput","pointer":"/paths/~1v1~1orders~1order~1upload/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/orders/order/upload","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrderInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/orders/order/upload","href":"api-order/import_order_v1_orders_order_upload_post","openApiOperationId":"import_order_v1_orders_order_upload_post","summary":"Import Order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/OrderInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderImport"}},"schemaId":"components/schemas/OrderImport"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1orders~1order~1upload/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderImport","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderImport"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-order/import_order_v1_orders_order_upload_post"}],"panels":[]}]},"httpPath":"/v1/orders/order/upload"},{"label":"Get Order Import Status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-order/get_order_import_status_v1_orders_order_upload__upload_id__get","routeSlug":"/docs/api-order/get_order_import_status_v1_orders_order_upload__upload_id__get","metadata":{"seo":{"title":"Get Order Import Status","description":"Get the status of an order import"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_order_import_status_v1_orders_order_upload__upload_id__get","name":"Get Order Import Status","isWebhook":false,"pointer":"/paths/~1v1~1orders~1order~1upload~1{upload_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Order Import Status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the status of an order import"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"upload_id","in":"path","schemaId":"schema_114","required":true}],"pointer":"/paths/~1v1~1orders~1order~1upload~1{upload_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/orders/order/upload/{upload_id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"upload_id","in":"path","required":true,"schemaId":"schema_114"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/orders/order/upload/{upload_id}","href":"api-order/get_order_import_status_v1_orders_order_upload__upload_id__get","openApiOperationId":"get_order_import_status_v1_orders_order_upload__upload_id__get","summary":"Get Order Import Status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderImport"}},"schemaId":"components/schemas/OrderImport"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1orders~1order~1upload~1{upload_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderImport","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderImport"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-order/get_order_import_status_v1_orders_order_upload__upload_id__get"}],"panels":[]}]},"httpPath":"/v1/orders/order/upload/{upload_id}"},{"label":"Get Order Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-order/get_order_details_v1_orders_order__order_id__get","routeSlug":"/docs/api-order/get_order_details_v1_orders_order__order_id__get","metadata":{"seo":{"title":"Get Order Details","description":"Fetch order detail"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_order_details_v1_orders_order__order_id__get","name":"Get Order Details","isWebhook":false,"pointer":"/paths/~1v1~1orders~1order~1{order_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Order Details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetch order detail"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"order_id","in":"path","schemaId":"schema_115","required":true}],"pointer":"/paths/~1v1~1orders~1order~1{order_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/orders/order/{order_id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"order_id","in":"path","required":true,"schemaId":"schema_115"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/orders/order/{order_id}","href":"api-order/get_order_details_v1_orders_order__order_id__get","openApiOperationId":"get_order_details_v1_orders_order__order_id__get","summary":"Get Order Details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderDetailOutput"}},"schemaId":"components/schemas/OrderDetailOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1orders~1order~1{order_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderDetailOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderDetailOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-order/get_order_details_v1_orders_order__order_id__get"}],"panels":[]}]},"httpPath":"/v1/orders/order/{order_id}"},{"label":"List Order Charges","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-order/list_order_charges_v1_orders_order__order_id__charges_get","routeSlug":"/docs/api-order/list_order_charges_v1_orders_order__order_id__charges_get","metadata":{"seo":{"title":"List Order Charges","description":"Charges for a certain order. Note that these charges are not final and may change"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"List_Order_Charges_v1_orders_order__order_id__charges_get","name":"List Order Charges","isWebhook":false,"pointer":"/paths/~1v1~1orders~1order~1{order_id}~1charges/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Order Charges","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Charges for a certain order. Note that these charges are not final and may change"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"order_id","in":"path","schemaId":"schema_115","required":true}],"pointer":"/paths/~1v1~1orders~1order~1{order_id}~1charges/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/orders/order/{order_id}/charges","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"order_id","in":"path","required":true,"schemaId":"schema_115"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/orders/order/{order_id}/charges","href":"api-order/list_order_charges_v1_orders_order__order_id__charges_get","openApiOperationId":"List_Order_Charges_v1_orders_order__order_id__charges_get","summary":"List Order Charges"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderChargesOutput"}},"schemaId":"components/schemas/OrderChargesOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1orders~1order~1{order_id}~1charges/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderChargesOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderChargesOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-order/list_order_charges_v1_orders_order__order_id__charges_get"}],"panels":[]}]},"httpPath":"/v1/orders/order/{order_id}/charges"},{"label":"Approve Order Charges","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-order/approve_order_charges_v1_orders_order__order_id__charges_approval_post","routeSlug":"/docs/api-order/approve_order_charges_v1_orders_order__order_id__charges_approval_post","metadata":{"seo":{"title":"Approve Order Charges","description":"Approve or reject certain charges on the order"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Approve_Order_Charges_v1_orders_order__order_id__charges_approval_post","name":"Approve Order Charges","isWebhook":false,"pointer":"/paths/~1v1~1orders~1order~1{order_id}~1charges~1approval/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Approve Order Charges","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Approve or reject certain charges on the order"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"order_id","in":"path","schemaId":"schema_115","required":true}],"pointer":"/paths/~1v1~1orders~1order~1{order_id}~1charges~1approval/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ChargesApprovalInput"}},"schemaId":"components/schemas/ChargesApprovalInput","pointer":"/paths/~1v1~1orders~1order~1{order_id}~1charges~1approval/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/orders/order/{order_id}/charges/approval","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"order_id","in":"path","required":true,"schemaId":"schema_115"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ChargesApprovalInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/orders/order/{order_id}/charges/approval","href":"api-order/approve_order_charges_v1_orders_order__order_id__charges_approval_post","openApiOperationId":"Approve_Order_Charges_v1_orders_order__order_id__charges_approval_post","summary":"Approve Order Charges"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/ChargesApprovalInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ChargesApprovalInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderChargesOutput"}},"schemaId":"components/schemas/OrderChargesOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1orders~1order~1{order_id}~1charges~1approval/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderChargesOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderChargesOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-order/approve_order_charges_v1_orders_order__order_id__charges_approval_post"}],"panels":[]}]},"httpPath":"/v1/orders/order/{order_id}/charges/approval"},{"label":"List Order Documents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-order/list_order_documents_v1_orders_order__order_id__documents_get","routeSlug":"/docs/api-order/list_order_documents_v1_orders_order__order_id__documents_get","metadata":{"seo":{"title":"List Order Documents","description":"Fetch documents for an order. This includes consignment documents"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_order_documents_v1_orders_order__order_id__documents_get","name":"List Order Documents","isWebhook":false,"pointer":"/paths/~1v1~1orders~1order~1{order_id}~1documents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Order Documents","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":"Fetch documents for an order. This includes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consignment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" documents"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"order_id","in":"path","schemaId":"schema_115","required":true}],"pointer":"/paths/~1v1~1orders~1order~1{order_id}~1documents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/orders/order/{order_id}/documents","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"order_id","in":"path","required":true,"schemaId":"schema_115"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/orders/order/{order_id}/documents","href":"api-order/list_order_documents_v1_orders_order__order_id__documents_get","openApiOperationId":"list_order_documents_v1_orders_order__order_id__documents_get","summary":"List Order Documents"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_116"}},"schemaId":"schema_116"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1orders~1order~1{order_id}~1documents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_116","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_116"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-order/list_order_documents_v1_orders_order__order_id__documents_get"}],"panels":[]}]},"httpPath":"/v1/orders/order/{order_id}/documents"},{"label":"Order Export","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-order/order_export_v1_orders_order__order_id__export_get","routeSlug":"/docs/api-order/order_export_v1_orders_order__order_id__export_get","metadata":{"seo":{"title":"Order Export","description":"Provides a minimal set of order data that can be used as a blueprint to create a new order"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"order_export_v1_orders_order__order_id__export_get","name":"Order Export","isWebhook":false,"pointer":"/paths/~1v1~1orders~1order~1{order_id}~1export/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order Export","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Provides a minimal set of order data that can be used as a blueprint to create a new order"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"order_id","in":"path","schemaId":"schema_115","required":true}],"pointer":"/paths/~1v1~1orders~1order~1{order_id}~1export/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/orders/order/{order_id}/export","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"order_id","in":"path","required":true,"schemaId":"schema_115"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/orders/order/{order_id}/export","href":"api-order/order_export_v1_orders_order__order_id__export_get","openApiOperationId":"order_export_v1_orders_order__order_id__export_get","summary":"Order Export"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderExport"}},"schemaId":"components/schemas/OrderExport"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1orders~1order~1{order_id}~1export/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderExport","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderExport"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-order/order_export_v1_orders_order__order_id__export_get"}],"panels":[]}]},"httpPath":"/v1/orders/order/{order_id}/export"},{"label":"Order Status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-order/order_status_v1_orders_order__order_id__status_get","routeSlug":"/docs/api-order/order_status_v1_orders_order__order_id__status_get","metadata":{"seo":{"title":"Order Status","description":"Order status endpoint. Provides information on the status of the order"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"order_status_v1_orders_order__order_id__status_get","name":"Order Status","isWebhook":false,"pointer":"/paths/~1v1~1orders~1order~1{order_id}~1status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order Status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Order status endpoint. Provides information on the status of the order"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"order_id","in":"path","schemaId":"schema_115","required":true}],"pointer":"/paths/~1v1~1orders~1order~1{order_id}~1status/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/orders/order/{order_id}/status","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"order_id","in":"path","required":true,"schemaId":"schema_115"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/orders/order/{order_id}/status","href":"api-order/order_status_v1_orders_order__order_id__status_get","openApiOperationId":"order_status_v1_orders_order__order_id__status_get","summary":"Order Status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderWithStatus"}},"schemaId":"components/schemas/OrderWithStatus"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1orders~1order~1{order_id}~1status/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderWithStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderWithStatus"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-order/order_status_v1_orders_order__order_id__status_get"}],"panels":[]}]},"httpPath":"/v1/orders/order/{order_id}/status"}],"content":{"contentType":"group","meta":{"name":"API / Order"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"API / Order","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/orders/order/upload","summary":"Import Order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/api-order/import_order_v1_orders_order_upload_post","deprecated":false},{"title":"/v1/orders/order/upload/{upload_id}","summary":"Get Order Import Status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-order/get_order_import_status_v1_orders_order_upload__upload_id__get","deprecated":false},{"title":"/v1/orders/order/{order_id}","summary":"Get Order Details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-order/get_order_details_v1_orders_order__order_id__get","deprecated":false},{"title":"/v1/orders/order/{order_id}/charges","summary":"List Order Charges","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-order/list_order_charges_v1_orders_order__order_id__charges_get","deprecated":false},{"title":"/v1/orders/order/{order_id}/charges/approval","summary":"Approve Order Charges","prefix":{"name":"post","color":"post"},"badges":[],"link":"/api-order/approve_order_charges_v1_orders_order__order_id__charges_approval_post","deprecated":false},{"title":"/v1/orders/order/{order_id}/documents","summary":"List Order Documents","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-order/list_order_documents_v1_orders_order__order_id__documents_get","deprecated":false},{"title":"/v1/orders/order/{order_id}/export","summary":"Order Export","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-order/order_export_v1_orders_order__order_id__export_get","deprecated":false},{"title":"/v1/orders/order/{order_id}/status","summary":"Order Status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-order/order_status_v1_orders_order__order_id__status_get","deprecated":false}]}]}]}]}},{"type":"group","label":"API / Resource","link":"/docs/api-resource","routeSlug":"/docs/api-resource","items":[{"label":"Create Resource","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-resource/create_resource_v1_resources_resource_post","routeSlug":"/docs/api-resource/create_resource_v1_resources_resource_post","metadata":{"seo":{"title":"Create Resource","description":"Create a new resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create_resource_v1_resources_resource_post","name":"Create Resource","isWebhook":false,"pointer":"/paths/~1v1~1resources~1resource/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Resource","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new resource."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_140"}},"schemaId":"schema_140","pointer":"/paths/~1v1~1resources~1resource/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/resources/resource","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_140"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/resources/resource","href":"api-resource/create_resource_v1_resources_resource_post","openApiOperationId":"Create_resource_v1_resources_resource_post","summary":"Create Resource"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"schema_140","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_140"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_141"}},"schemaId":"schema_141"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1resources~1resource/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_141","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_141"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-resource/create_resource_v1_resources_resource_post"}],"panels":[]}]},"httpPath":"/v1/resources/resource"},{"label":"List Resources","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-resource/list_resources_v1_resources_resource_get","routeSlug":"/docs/api-resource/list_resources_v1_resources_resource_get","metadata":{"seo":{"title":"List Resources","description":"List all resources"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"List_resources_v1_resources_resource_get","name":"List Resources","isWebhook":false,"pointer":"/paths/~1v1~1resources~1resource/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Resources","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all resources"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_89","description":"Pagination cursor. Mutually exclusive with other query parameters"},{"name":"updated_after","in":"query","schemaId":"schema_108","description":"Filter to fetch the resources updated after this time. Timestamp format is ISO 8601 YYYY-MM-DDTHH:MM:SSZ"},{"name":"external_id","in":"query","schemaId":"schema_137","description":"External resource identifier to match exactly."},{"name":"external_id:in","in":"query","schemaId":"schema_138","description":"External resource identifiers to match. Comma-separated list."},{"name":"resource_type","in":"query","schemaId":"schema_142","description":"Resource type to match exactly."},{"name":"resource_type:in","in":"query","schemaId":"schema_143","description":"Resource types to match. Comma-separated list."}],"pointer":"/paths/~1v1~1resources~1resource/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/resources/resource","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_89"},{"name":"updated_after","in":"query","required":false,"schemaId":"schema_108"},{"name":"external_id","in":"query","required":false,"schemaId":"schema_137"},{"name":"external_id:in","in":"query","required":false,"schemaId":"schema_138"},{"name":"resource_type","in":"query","required":false,"schemaId":"schema_142"},{"name":"resource_type:in","in":"query","required":false,"schemaId":"schema_143"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/resources/resource","href":"api-resource/list_resources_v1_resources_resource_get","openApiOperationId":"List_resources_v1_resources_resource_get","summary":"List Resources"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListResourceOutput"}},"schemaId":"components/schemas/ListResourceOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1resources~1resource/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListResourceOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListResourceOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-resource/list_resources_v1_resources_resource_get"}],"panels":[]}]},"httpPath":"/v1/resources/resource"},{"label":"Update Resource","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-resource/update_resource_v1_resources_resource__resource_id__put","routeSlug":"/docs/api-resource/update_resource_v1_resources_resource__resource_id__put","metadata":{"seo":{"title":"Update Resource","description":"Update an existing resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update_resource_v1_resources_resource__resource_id__put","name":"Update Resource","isWebhook":false,"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Resource","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update an existing resource."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"resource_id","in":"path","schemaId":"schema_144","required":true}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_140"}},"schemaId":"schema_140","pointer":"/paths/~1v1~1resources~1resource~1{resource_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/resources/resource/{resource_id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"resource_id","in":"path","required":true,"schemaId":"schema_144"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_140"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/resources/resource/{resource_id}","href":"api-resource/update_resource_v1_resources_resource__resource_id__put","openApiOperationId":"Update_resource_v1_resources_resource__resource_id__put","summary":"Update Resource"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"schema_140","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_140"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_145"}},"schemaId":"schema_145"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_145","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_145"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-resource/update_resource_v1_resources_resource__resource_id__put"}],"panels":[]}]},"httpPath":"/v1/resources/resource/{resource_id}"},{"label":"Patch Resource","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-resource/patch_resource_v1_resources_resource__resource_id__patch","routeSlug":"/docs/api-resource/patch_resource_v1_resources_resource__resource_id__patch","metadata":{"seo":{"title":"Patch Resource","description":"Partially update an existing resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Patch_resource_v1_resources_resource__resource_id__patch","name":"Patch Resource","isWebhook":false,"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch Resource","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Partially update an existing resource."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"resource_id","in":"path","schemaId":"schema_144","required":true}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_146"}},"schemaId":"schema_146","pointer":"/paths/~1v1~1resources~1resource~1{resource_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/resources/resource/{resource_id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"resource_id","in":"path","required":true,"schemaId":"schema_144"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_146"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/resources/resource/{resource_id}","href":"api-resource/patch_resource_v1_resources_resource__resource_id__patch","openApiOperationId":"Patch_resource_v1_resources_resource__resource_id__patch","summary":"Patch Resource"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"schema_146","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_146"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_147"}},"schemaId":"schema_147"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_147","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_147"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-resource/patch_resource_v1_resources_resource__resource_id__patch"}],"panels":[]}]},"httpPath":"/v1/resources/resource/{resource_id}"},{"label":"Archive Resource","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-resource/archive_resource_v1_resources_resource__resource_id__delete","routeSlug":"/docs/api-resource/archive_resource_v1_resources_resource__resource_id__delete","metadata":{"seo":{"title":"Archive Resource","description":"Archive a resource"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Archive_resource_v1_resources_resource__resource_id__delete","name":"Archive Resource","isWebhook":false,"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Archive Resource","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Archive a resource"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"resource_id","in":"path","schemaId":"schema_144","required":true}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/resources/resource/{resource_id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"resource_id","in":"path","required":true,"schemaId":"schema_144"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["204","400","401","403","422","429","500","503"],"pointer":"/v1/resources/resource/{resource_id}","href":"api-resource/archive_resource_v1_resources_resource__resource_id__delete","openApiOperationId":"Archive_resource_v1_resources_resource__resource_id__delete","summary":"Archive Resource"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful Response"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-resource/archive_resource_v1_resources_resource__resource_id__delete"}],"panels":[]}]},"httpPath":"/v1/resources/resource/{resource_id}"},{"label":"Get Resource","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-resource/get_resource_v1_resources_resource__resource_id__get","routeSlug":"/docs/api-resource/get_resource_v1_resources_resource__resource_id__get","metadata":{"seo":{"title":"Get Resource","description":"Fetches a resource"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get_resource_v1_resources_resource__resource_id__get","name":"Get Resource","isWebhook":false,"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Resource","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches a resource"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"resource_id","in":"path","schemaId":"schema_144","required":true}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/resources/resource/{resource_id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"resource_id","in":"path","required":true,"schemaId":"schema_144"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/resources/resource/{resource_id}","href":"api-resource/get_resource_v1_resources_resource__resource_id__get","openApiOperationId":"Get_resource_v1_resources_resource__resource_id__get","summary":"Get Resource"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_148"}},"schemaId":"schema_148"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_148","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_148"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-resource/get_resource_v1_resources_resource__resource_id__get"}],"panels":[]}]},"httpPath":"/v1/resources/resource/{resource_id}"},{"label":"List Resource Unavailabilities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-resource/list_resource_unavailabilities_v1_resources_resource__resource_id__unavailability_get","routeSlug":"/docs/api-resource/list_resource_unavailabilities_v1_resources_resource__resource_id__unavailability_get","metadata":{"seo":{"title":"List Resource Unavailabilities","description":"List all unavailabilities for a resource"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"List_resource_unavailabilities_v1_resources_resource__resource_id__unavailability_get","name":"List Resource Unavailabilities","isWebhook":false,"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1unavailability/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Resource Unavailabilities","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all unavailabilities for a resource"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"resource_id","in":"path","schemaId":"schema_144","required":true}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1unavailability/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_89","description":"Pagination cursor. Mutually exclusive with other query parameters"},{"name":"start_time","in":"query","schemaId":"schema_134","description":"Filter to fetch unavailabilities after this time"},{"name":"end_time","in":"query","schemaId":"schema_135","description":"Filter to fetch unavailabilities before this time"}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1unavailability/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/resources/resource/{resource_id}/unavailability","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"resource_id","in":"path","required":true,"schemaId":"schema_144"}],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_89"},{"name":"start_time","in":"query","required":false,"schemaId":"schema_134"},{"name":"end_time","in":"query","required":false,"schemaId":"schema_135"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/resources/resource/{resource_id}/unavailability","href":"api-resource/list_resource_unavailabilities_v1_resources_resource__resource_id__unavailability_get","openApiOperationId":"List_resource_unavailabilities_v1_resources_resource__resource_id__unavailability_get","summary":"List Resource Unavailabilities"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListResourceUnavailabilityOutput"}},"schemaId":"components/schemas/ListResourceUnavailabilityOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1unavailability/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListResourceUnavailabilityOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListResourceUnavailabilityOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-resource/list_resource_unavailabilities_v1_resources_resource__resource_id__unavailability_get"}],"panels":[]}]},"httpPath":"/v1/resources/resource/{resource_id}/unavailability"},{"label":"Create Resource Unavailabilities","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-resource/create_resource_unavailabilities_v1_resources_resource__resource_id__unavailability_post","routeSlug":"/docs/api-resource/create_resource_unavailabilities_v1_resources_resource__resource_id__unavailability_post","metadata":{"seo":{"title":"Create Resource Unavailabilities","description":"Create a new unavailability for a resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create_resource_unavailabilities_v1_resources_resource__resource_id__unavailability_post","name":"Create Resource Unavailabilities","isWebhook":false,"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1unavailability/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Resource Unavailabilities","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new unavailability for a resource."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"resource_id","in":"path","schemaId":"schema_144","required":true}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1unavailability/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ResourceUnavailabilityInput"}},"schemaId":"components/schemas/ResourceUnavailabilityInput","pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1unavailability/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/resources/resource/{resource_id}/unavailability","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"resource_id","in":"path","required":true,"schemaId":"schema_144"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ResourceUnavailabilityInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/resources/resource/{resource_id}/unavailability","href":"api-resource/create_resource_unavailabilities_v1_resources_resource__resource_id__unavailability_post","openApiOperationId":"Create_resource_unavailabilities_v1_resources_resource__resource_id__unavailability_post","summary":"Create Resource Unavailabilities"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/ResourceUnavailabilityInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ResourceUnavailabilityInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceUnavailabilityOutput"}},"schemaId":"components/schemas/ResourceUnavailabilityOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1unavailability/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ResourceUnavailabilityOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceUnavailabilityOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-resource/create_resource_unavailabilities_v1_resources_resource__resource_id__unavailability_post"}],"panels":[]}]},"httpPath":"/v1/resources/resource/{resource_id}/unavailability"},{"label":"Get Resource Unavailability","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-resource/get_resource_unavailability_v1_resources_resource__resource_id__unavailability__id__get","routeSlug":"/docs/api-resource/get_resource_unavailability_v1_resources_resource__resource_id__unavailability__id__get","metadata":{"seo":{"title":"Get Resource Unavailability","description":"Fetch a resource unavailability"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get_resource_unavailability_v1_resources_resource__resource_id__unavailability__id__get","name":"Get Resource Unavailability","isWebhook":false,"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1unavailability~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Resource Unavailability","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetch a resource unavailability"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"resource_id","in":"path","schemaId":"schema_144","required":true},{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1unavailability~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/resources/resource/{resource_id}/unavailability/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"resource_id","in":"path","required":true,"schemaId":"schema_144"},{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/resources/resource/{resource_id}/unavailability/{id}","href":"api-resource/get_resource_unavailability_v1_resources_resource__resource_id__unavailability__id__get","openApiOperationId":"Get_resource_unavailability_v1_resources_resource__resource_id__unavailability__id__get","summary":"Get Resource Unavailability"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceUnavailabilityOutput"}},"schemaId":"components/schemas/ResourceUnavailabilityOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1unavailability~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ResourceUnavailabilityOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceUnavailabilityOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-resource/get_resource_unavailability_v1_resources_resource__resource_id__unavailability__id__get"}],"panels":[]}]},"httpPath":"/v1/resources/resource/{resource_id}/unavailability/{id}"},{"label":"Update Resource Unavailabilities","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-resource/update_resource_unavailabilities_v1_resources_resource__resource_id__unavailability__id__put","routeSlug":"/docs/api-resource/update_resource_unavailabilities_v1_resources_resource__resource_id__unavailability__id__put","metadata":{"seo":{"title":"Update Resource Unavailabilities","description":"Update an existing unavailability for a resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update_resource_unavailabilities_v1_resources_resource__resource_id__unavailability__id__put","name":"Update Resource Unavailabilities","isWebhook":false,"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1unavailability~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Resource Unavailabilities","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update an existing unavailability for a resource."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"resource_id","in":"path","schemaId":"schema_144","required":true},{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1unavailability~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ResourceUnavailabilityInput"}},"schemaId":"components/schemas/ResourceUnavailabilityInput","pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1unavailability~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/resources/resource/{resource_id}/unavailability/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"resource_id","in":"path","required":true,"schemaId":"schema_144"},{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ResourceUnavailabilityInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/resources/resource/{resource_id}/unavailability/{id}","href":"api-resource/update_resource_unavailabilities_v1_resources_resource__resource_id__unavailability__id__put","openApiOperationId":"Update_resource_unavailabilities_v1_resources_resource__resource_id__unavailability__id__put","summary":"Update Resource Unavailabilities"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/ResourceUnavailabilityInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ResourceUnavailabilityInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceUnavailabilityOutput"}},"schemaId":"components/schemas/ResourceUnavailabilityOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1unavailability~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ResourceUnavailabilityOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceUnavailabilityOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-resource/update_resource_unavailabilities_v1_resources_resource__resource_id__unavailability__id__put"}],"panels":[]}]},"httpPath":"/v1/resources/resource/{resource_id}/unavailability/{id}"},{"label":"Delete Resource Unavailabilities","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-resource/delete_resource_unavailabilities_v1_resources_resource__resource_id__unavailability__id__delete","routeSlug":"/docs/api-resource/delete_resource_unavailabilities_v1_resources_resource__resource_id__unavailability__id__delete","metadata":{"seo":{"title":"Delete Resource Unavailabilities","description":"Delete a resource unavailability"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete_resource_unavailabilities_v1_resources_resource__resource_id__unavailability__id__delete","name":"Delete Resource Unavailabilities","isWebhook":false,"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1unavailability~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Resource Unavailabilities","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a resource unavailability"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"resource_id","in":"path","schemaId":"schema_144","required":true},{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1unavailability~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/resources/resource/{resource_id}/unavailability/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"resource_id","in":"path","required":true,"schemaId":"schema_144"},{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["204","400","401","403","422","429","500","503"],"pointer":"/v1/resources/resource/{resource_id}/unavailability/{id}","href":"api-resource/delete_resource_unavailabilities_v1_resources_resource__resource_id__unavailability__id__delete","openApiOperationId":"Delete_resource_unavailabilities_v1_resources_resource__resource_id__unavailability__id__delete","summary":"Delete Resource Unavailabilities"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful Response"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1unavailability~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-resource/delete_resource_unavailabilities_v1_resources_resource__resource_id__unavailability__id__delete"}],"panels":[]}]},"httpPath":"/v1/resources/resource/{resource_id}/unavailability/{id}"},{"label":"List Resource Validities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-resource/list_resource_validities_v1_resources_resource__resource_id__validity_get","routeSlug":"/docs/api-resource/list_resource_validities_v1_resources_resource__resource_id__validity_get","metadata":{"seo":{"title":"List Resource Validities","description":"List all validities for a resource"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"List_resource_validities_v1_resources_resource__resource_id__validity_get","name":"List Resource Validities","isWebhook":false,"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1validity/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Resource Validities","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all validities for a resource"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"resource_id","in":"path","schemaId":"schema_144","required":true}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1validity/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_89","description":"Pagination cursor. Mutually exclusive with other query parameters"},{"name":"start_time","in":"query","schemaId":"schema_134","description":"Filter to fetch unavailabilities after this time"},{"name":"end_time","in":"query","schemaId":"schema_135","description":"Filter to fetch unavailabilities before this time"}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1validity/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/resources/resource/{resource_id}/validity","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"resource_id","in":"path","required":true,"schemaId":"schema_144"}],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_89"},{"name":"start_time","in":"query","required":false,"schemaId":"schema_134"},{"name":"end_time","in":"query","required":false,"schemaId":"schema_135"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/resources/resource/{resource_id}/validity","href":"api-resource/list_resource_validities_v1_resources_resource__resource_id__validity_get","openApiOperationId":"List_resource_validities_v1_resources_resource__resource_id__validity_get","summary":"List Resource Validities"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListResourceValidityOutput"}},"schemaId":"components/schemas/ListResourceValidityOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1validity/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListResourceValidityOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListResourceValidityOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-resource/list_resource_validities_v1_resources_resource__resource_id__validity_get"}],"panels":[]}]},"httpPath":"/v1/resources/resource/{resource_id}/validity"},{"label":"Create Resource Validity Request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-resource/create_resource_validity_request_v1_resources_resource__resource_id__validity_post","routeSlug":"/docs/api-resource/create_resource_validity_request_v1_resources_resource__resource_id__validity_post","metadata":{"seo":{"title":"Create Resource Validity Request","description":"Create a new validity request for a resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create_resource_validity_request_v1_resources_resource__resource_id__validity_post","name":"Create Resource Validity Request","isWebhook":false,"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1validity/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Resource Validity Request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new validity request for a resource."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"resource_id","in":"path","schemaId":"schema_144","required":true}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1validity/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ResourceValidityInput"}},"schemaId":"components/schemas/ResourceValidityInput","pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1validity/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/resources/resource/{resource_id}/validity","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"resource_id","in":"path","required":true,"schemaId":"schema_144"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ResourceValidityInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/resources/resource/{resource_id}/validity","href":"api-resource/create_resource_validity_request_v1_resources_resource__resource_id__validity_post","openApiOperationId":"Create_resource_validity_request_v1_resources_resource__resource_id__validity_post","summary":"Create Resource Validity Request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/ResourceValidityInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ResourceValidityInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceValidityOutput"}},"schemaId":"components/schemas/ResourceValidityOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1validity/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ResourceValidityOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceValidityOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-resource/create_resource_validity_request_v1_resources_resource__resource_id__validity_post"}],"panels":[]}]},"httpPath":"/v1/resources/resource/{resource_id}/validity"},{"label":"Get Resource Validity","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-resource/get_resource_validity_v1_resources_resource__resource_id__validity__id__get","routeSlug":"/docs/api-resource/get_resource_validity_v1_resources_resource__resource_id__validity__id__get","metadata":{"seo":{"title":"Get Resource Validity","description":"Fetches a specific validity for a resource"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get_resource_validity_v1_resources_resource__resource_id__validity__id__get","name":"Get Resource Validity","isWebhook":false,"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1validity~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Resource Validity","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches a specific validity for a resource"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"resource_id","in":"path","schemaId":"schema_144","required":true},{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1validity~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/resources/resource/{resource_id}/validity/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"resource_id","in":"path","required":true,"schemaId":"schema_144"},{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/resources/resource/{resource_id}/validity/{id}","href":"api-resource/get_resource_validity_v1_resources_resource__resource_id__validity__id__get","openApiOperationId":"Get_resource_validity_v1_resources_resource__resource_id__validity__id__get","summary":"Get Resource Validity"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceValidityOutput"}},"schemaId":"components/schemas/ResourceValidityOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1validity~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ResourceValidityOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceValidityOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-resource/get_resource_validity_v1_resources_resource__resource_id__validity__id__get"}],"panels":[]}]},"httpPath":"/v1/resources/resource/{resource_id}/validity/{id}"},{"label":"Update Resource Validity","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-resource/update_resource_validity_v1_resources_resource__resource_id__validity__id__put","routeSlug":"/docs/api-resource/update_resource_validity_v1_resources_resource__resource_id__validity__id__put","metadata":{"seo":{"title":"Update Resource Validity","description":"Update an existing validity for a resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Update_resource_validity_v1_resources_resource__resource_id__validity__id__put","name":"Update Resource Validity","isWebhook":false,"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1validity~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Resource Validity","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update an existing validity for a resource."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"resource_id","in":"path","schemaId":"schema_144","required":true},{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1validity~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ResourceValidityInput"}},"schemaId":"components/schemas/ResourceValidityInput","pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1validity~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/resources/resource/{resource_id}/validity/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"resource_id","in":"path","required":true,"schemaId":"schema_144"},{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ResourceValidityInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/resources/resource/{resource_id}/validity/{id}","href":"api-resource/update_resource_validity_v1_resources_resource__resource_id__validity__id__put","openApiOperationId":"Update_resource_validity_v1_resources_resource__resource_id__validity__id__put","summary":"Update Resource Validity"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/ResourceValidityInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ResourceValidityInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceValidityOutput"}},"schemaId":"components/schemas/ResourceValidityOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1validity~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ResourceValidityOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceValidityOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-resource/update_resource_validity_v1_resources_resource__resource_id__validity__id__put"}],"panels":[]}]},"httpPath":"/v1/resources/resource/{resource_id}/validity/{id}"},{"label":"Delete Resource Validity","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-resource/delete_resource_validity_v1_resources_resource__resource_id__validity__id__delete","routeSlug":"/docs/api-resource/delete_resource_validity_v1_resources_resource__resource_id__validity__id__delete","metadata":{"seo":{"title":"Delete Resource Validity","description":"Delete a resource validity"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Delete_resource_validity_v1_resources_resource__resource_id__validity__id__delete","name":"Delete Resource Validity","isWebhook":false,"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1validity~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Resource Validity","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a resource validity"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"resource_id","in":"path","schemaId":"schema_144","required":true},{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1validity~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/resources/resource/{resource_id}/validity/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"resource_id","in":"path","required":true,"schemaId":"schema_144"},{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["204","400","401","403","422","429","500","503"],"pointer":"/v1/resources/resource/{resource_id}/validity/{id}","href":"api-resource/delete_resource_validity_v1_resources_resource__resource_id__validity__id__delete","openApiOperationId":"Delete_resource_validity_v1_resources_resource__resource_id__validity__id__delete","summary":"Delete Resource Validity"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful Response"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1validity~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-resource/delete_resource_validity_v1_resources_resource__resource_id__validity__id__delete"}],"panels":[]}]},"httpPath":"/v1/resources/resource/{resource_id}/validity/{id}"},{"label":"Get Resource Validity Documents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-resource/get_resource_validity_documents_v1_resources_resource__resource_id__validity__id__documents_get","routeSlug":"/docs/api-resource/get_resource_validity_documents_v1_resources_resource__resource_id__validity__id__documents_get","metadata":{"seo":{"title":"Get Resource Validity Documents","description":"Fetch all documents associated with a specific resource validity."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get_resource_validity_documents_v1_resources_resource__resource_id__validity__id__documents_get","name":"Get Resource Validity Documents","isWebhook":false,"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1validity~1{id}~1documents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Resource Validity Documents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetch all documents associated with a specific resource validity."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"resource_id","in":"path","schemaId":"schema_144","required":true},{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1validity~1{id}~1documents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/resources/resource/{resource_id}/validity/{id}/documents","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"resource_id","in":"path","required":true,"schemaId":"schema_144"},{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/resources/resource/{resource_id}/validity/{id}/documents","href":"api-resource/get_resource_validity_documents_v1_resources_resource__resource_id__validity__id__documents_get","openApiOperationId":"Get_resource_validity_documents_v1_resources_resource__resource_id__validity__id__documents_get","summary":"Get Resource Validity Documents"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_149"}},"schemaId":"schema_149"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1resources~1resource~1{resource_id}~1validity~1{id}~1documents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_149","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_149"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-resource/get_resource_validity_documents_v1_resources_resource__resource_id__validity__id__documents_get"}],"panels":[]}]},"httpPath":"/v1/resources/resource/{resource_id}/validity/{id}/documents"},{"label":"List Resource Groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-resource/list_resource_groups_v1_resources_resource_groups_get","routeSlug":"/docs/api-resource/list_resource_groups_v1_resources_resource_groups_get","metadata":{"seo":{"title":"List Resource Groups","description":"List the resource groups resources can be allocated to. Archived resource groups are not included."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"List_resource_groups_v1_resources_resource_groups_get","name":"List Resource Groups","isWebhook":false,"pointer":"/paths/~1v1~1resources~1resource_groups/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Resource Groups","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List the resource groups resources can be allocated to. Archived resource groups are not included."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_89","description":"Pagination cursor. Mutually exclusive with other query parameters"},{"name":"code","in":"query","schemaId":"schema_92","description":"Resource group code to match exactly."},{"name":"code:in","in":"query","schemaId":"schema_93","description":"Resource group codes to match. Comma-separated list."}],"pointer":"/paths/~1v1~1resources~1resource_groups/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/resources/resource_groups","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_89"},{"name":"code","in":"query","required":false,"schemaId":"schema_92"},{"name":"code:in","in":"query","required":false,"schemaId":"schema_93"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/resources/resource_groups","href":"api-resource/list_resource_groups_v1_resources_resource_groups_get","openApiOperationId":"List_resource_groups_v1_resources_resource_groups_get","summary":"List Resource Groups"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListResourceGroupOutput"}},"schemaId":"components/schemas/ListResourceGroupOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1resources~1resource_groups/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListResourceGroupOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListResourceGroupOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-resource/list_resource_groups_v1_resources_resource_groups_get"}],"panels":[]}]},"httpPath":"/v1/resources/resource_groups"}],"content":{"contentType":"group","meta":{"name":"API / Resource"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"API / Resource","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/resources/resource","summary":"Create Resource","prefix":{"name":"post","color":"post"},"badges":[],"link":"/api-resource/create_resource_v1_resources_resource_post","deprecated":false},{"title":"/v1/resources/resource","summary":"List Resources","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-resource/list_resources_v1_resources_resource_get","deprecated":false},{"title":"/v1/resources/resource/{resource_id}","summary":"Update Resource","prefix":{"name":"put","color":"put"},"badges":[],"link":"/api-resource/update_resource_v1_resources_resource__resource_id__put","deprecated":false},{"title":"/v1/resources/resource/{resource_id}","summary":"Patch Resource","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/api-resource/patch_resource_v1_resources_resource__resource_id__patch","deprecated":false},{"title":"/v1/resources/resource/{resource_id}","summary":"Archive Resource","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/api-resource/archive_resource_v1_resources_resource__resource_id__delete","deprecated":false},{"title":"/v1/resources/resource/{resource_id}","summary":"Get Resource","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-resource/get_resource_v1_resources_resource__resource_id__get","deprecated":false},{"title":"/v1/resources/resource/{resource_id}/unavailability","summary":"List Resource Unavailabilities","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-resource/list_resource_unavailabilities_v1_resources_resource__resource_id__unavailability_get","deprecated":false},{"title":"/v1/resources/resource/{resource_id}/unavailability","summary":"Create Resource Unavailabilities","prefix":{"name":"post","color":"post"},"badges":[],"link":"/api-resource/create_resource_unavailabilities_v1_resources_resource__resource_id__unavailability_post","deprecated":false},{"title":"/v1/resources/resource/{resource_id}/unavailability/{id}","summary":"Get Resource Unavailability","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-resource/get_resource_unavailability_v1_resources_resource__resource_id__unavailability__id__get","deprecated":false},{"title":"/v1/resources/resource/{resource_id}/unavailability/{id}","summary":"Update Resource Unavailabilities","prefix":{"name":"put","color":"put"},"badges":[],"link":"/api-resource/update_resource_unavailabilities_v1_resources_resource__resource_id__unavailability__id__put","deprecated":false},{"title":"/v1/resources/resource/{resource_id}/unavailability/{id}","summary":"Delete Resource Unavailabilities","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/api-resource/delete_resource_unavailabilities_v1_resources_resource__resource_id__unavailability__id__delete","deprecated":false},{"title":"/v1/resources/resource/{resource_id}/validity","summary":"List Resource Validities","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-resource/list_resource_validities_v1_resources_resource__resource_id__validity_get","deprecated":false},{"title":"/v1/resources/resource/{resource_id}/validity","summary":"Create Resource Validity Request","prefix":{"name":"post","color":"post"},"badges":[],"link":"/api-resource/create_resource_validity_request_v1_resources_resource__resource_id__validity_post","deprecated":false},{"title":"/v1/resources/resource/{resource_id}/validity/{id}","summary":"Get Resource Validity","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-resource/get_resource_validity_v1_resources_resource__resource_id__validity__id__get","deprecated":false},{"title":"/v1/resources/resource/{resource_id}/validity/{id}","summary":"Update Resource Validity","prefix":{"name":"put","color":"put"},"badges":[],"link":"/api-resource/update_resource_validity_v1_resources_resource__resource_id__validity__id__put","deprecated":false},{"title":"/v1/resources/resource/{resource_id}/validity/{id}","summary":"Delete Resource Validity","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/api-resource/delete_resource_validity_v1_resources_resource__resource_id__validity__id__delete","deprecated":false},{"title":"/v1/resources/resource/{resource_id}/validity/{id}/documents","summary":"Get Resource Validity Documents","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-resource/get_resource_validity_documents_v1_resources_resource__resource_id__validity__id__documents_get","deprecated":false},{"title":"/v1/resources/resource_groups","summary":"List Resource Groups","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-resource/list_resource_groups_v1_resources_resource_groups_get","deprecated":false}]}]}]}]}},{"type":"group","label":"API / Task","link":"/docs/api-task","routeSlug":"/docs/api-task","items":[{"label":"List Available Tasks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-task/list_available_tasks_v1_tasks_available_tasks_get","routeSlug":"/docs/api-task/list_available_tasks_v1_tasks_available_tasks_get","metadata":{"seo":{"title":"List Available Tasks","description":"List Available Tasks"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_available_tasks_v1_tasks_available_tasks_get","name":"List Available Tasks","isWebhook":false,"pointer":"/paths/~1v1~1tasks~1available-tasks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Available Tasks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/tasks/available-tasks","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500","503"],"pointer":"/v1/tasks/available-tasks","href":"api-task/list_available_tasks_v1_tasks_available_tasks_get","openApiOperationId":"list_available_tasks_v1_tasks_available_tasks_get","summary":"List Available Tasks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AvailableTasks"}},"schemaId":"components/schemas/AvailableTasks"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1tasks~1available-tasks/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AvailableTasks","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AvailableTasks"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-task/list_available_tasks_v1_tasks_available_tasks_get"}],"panels":[]}]},"httpPath":"/v1/tasks/available-tasks"},{"label":"Get Task Detail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-task/get_task_detail_v1_tasks_task__id__get","routeSlug":"/docs/api-task/get_task_detail_v1_tasks_task__id__get","metadata":{"seo":{"title":"Get Task Detail","description":"Get Task Detail"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_task_detail_v1_tasks_task__id__get","name":"Get Task Detail","isWebhook":false,"pointer":"/paths/~1v1~1tasks~1task~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Task Detail","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1tasks~1task~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/tasks/task/{id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/tasks/task/{id}","href":"api-task/get_task_detail_v1_tasks_task__id__get","openApiOperationId":"get_task_detail_v1_tasks_task__id__get","summary":"Get Task Detail"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaskDetail"}},"schemaId":"components/schemas/TaskDetail"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1tasks~1task~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TaskDetail","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaskDetail"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-task/get_task_detail_v1_tasks_task__id__get"}],"panels":[]}]},"httpPath":"/v1/tasks/task/{id}"},{"label":"Update Task Status","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-task/update_task_status_v1_tasks_task__id__update_status_post","routeSlug":"/docs/api-task/update_task_status_v1_tasks_task__id__update_status_post","metadata":{"seo":{"title":"Update Task Status","description":"Update Task Status"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_task_status_v1_tasks_task__id__update_status_post","name":"Update Task Status","isWebhook":false,"pointer":"/paths/~1v1~1tasks~1task~1{id}~1update-status/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Task Status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_94","required":true}],"pointer":"/paths/~1v1~1tasks~1task~1{id}~1update-status/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TaskUpdateInput"}},"schemaId":"components/schemas/TaskUpdateInput","pointer":"/paths/~1v1~1tasks~1task~1{id}~1update-status/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/tasks/task/{id}/update-status","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_94"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TaskUpdateInput"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/tasks/task/{id}/update-status","href":"api-task/update_task_status_v1_tasks_task__id__update_status_post","openApiOperationId":"update_task_status_v1_tasks_task__id__update_status_post","summary":"Update Task Status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/TaskUpdateInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TaskUpdateInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaskUpdate"}},"schemaId":"components/schemas/TaskUpdate"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1tasks~1task~1{id}~1update-status/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TaskUpdate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaskUpdate"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-task/update_task_status_v1_tasks_task__id__update_status_post"}],"panels":[]}]},"httpPath":"/v1/tasks/task/{id}/update-status"}],"content":{"contentType":"group","meta":{"name":"API / Task"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"API / Task","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/tasks/available-tasks","summary":"List Available Tasks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-task/list_available_tasks_v1_tasks_available_tasks_get","deprecated":false},{"title":"/v1/tasks/task/{id}","summary":"Get Task Detail","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-task/get_task_detail_v1_tasks_task__id__get","deprecated":false},{"title":"/v1/tasks/task/{id}/update-status","summary":"Update Task Status","prefix":{"name":"post","color":"post"},"badges":[],"link":"/api-task/update_task_status_v1_tasks_task__id__update_status_post","deprecated":false}]}]}]}]}},{"type":"group","label":"API / Trip","link":"/docs/api-trip","routeSlug":"/docs/api-trip","items":[{"label":"Get Trip By Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-trip/get_trip_by_id_v1_trips_trip__trip_id__get","routeSlug":"/docs/api-trip/get_trip_by_id_v1_trips_trip__trip_id__get","metadata":{"seo":{"title":"Get Trip By Id","description":"Get trip"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_trip_by_id_v1_trips_trip__trip_id__get","name":"Get Trip By Id","isWebhook":false,"pointer":"/paths/~1v1~1trips~1trip~1{trip_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Trip By Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get trip"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"trip_id","in":"path","schemaId":"schema_158","required":true}],"pointer":"/paths/~1v1~1trips~1trip~1{trip_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/trips/trip/{trip_id}","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"trip_id","in":"path","required":true,"schemaId":"schema_158"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/trips/trip/{trip_id}","href":"api-trip/get_trip_by_id_v1_trips_trip__trip_id__get","openApiOperationId":"get_trip_by_id_v1_trips_trip__trip_id__get","summary":"Get Trip By Id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TripOutput"}},"schemaId":"components/schemas/TripOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1trips~1trip~1{trip_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TripOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TripOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-trip/get_trip_by_id_v1_trips_trip__trip_id__get"}],"panels":[]}]},"httpPath":"/v1/trips/trip/{trip_id}"},{"label":"Get Trip Costs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-trip/get_trip_costs_v1_trips_trip__trip_id__costs_get","routeSlug":"/docs/api-trip/get_trip_costs_v1_trips_trip__trip_id__costs_get","metadata":{"seo":{"title":"Get Trip Costs","description":"Get the cost charges associated with this trip"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_trip_costs_v1_trips_trip__trip_id__costs_get","name":"Get Trip Costs","isWebhook":false,"pointer":"/paths/~1v1~1trips~1trip~1{trip_id}~1costs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Trip Costs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the cost charges associated with this trip"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"trip_id","in":"path","schemaId":"schema_158","required":true}],"pointer":"/paths/~1v1~1trips~1trip~1{trip_id}~1costs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/trips/trip/{trip_id}/costs","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"trip_id","in":"path","required":true,"schemaId":"schema_158"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/trips/trip/{trip_id}/costs","href":"api-trip/get_trip_costs_v1_trips_trip__trip_id__costs_get","openApiOperationId":"get_trip_costs_v1_trips_trip__trip_id__costs_get","summary":"Get Trip Costs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TripCostsOutput"}},"schemaId":"components/schemas/TripCostsOutput"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1trips~1trip~1{trip_id}~1costs/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TripCostsOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TripCostsOutput"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-trip/get_trip_costs_v1_trips_trip__trip_id__costs_get"}],"panels":[]}]},"httpPath":"/v1/trips/trip/{trip_id}/costs"},{"label":"Get Trip Documents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/api-trip/get_trip_documents_v1_trips_trip__trip_id__documents_get","routeSlug":"/docs/api-trip/get_trip_documents_v1_trips_trip__trip_id__documents_get","metadata":{"seo":{"title":"Get Trip Documents","description":"Fetch trip documents. This includes order and consignment documents"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_trip_documents_v1_trips_trip__trip_id__documents_get","name":"Get Trip Documents","isWebhook":false,"pointer":"/paths/~1v1~1trips~1trip~1{trip_id}~1documents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Trip Documents","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":"Fetch trip documents. This includes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consignment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" documents"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"trip_id","in":"path","schemaId":"schema_158","required":true}],"pointer":"/paths/~1v1~1trips~1trip~1{trip_id}~1documents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/trips/trip/{trip_id}/documents","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[{"name":"trip_id","in":"path","required":true,"schemaId":"schema_158"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/trips/trip/{trip_id}/documents","href":"api-trip/get_trip_documents_v1_trips_trip__trip_id__documents_get","openApiOperationId":"get_trip_documents_v1_trips_trip__trip_id__documents_get","summary":"Get Trip Documents"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_159"}},"schemaId":"schema_159"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1trips~1trip~1{trip_id}~1documents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_159","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_159"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-trip/get_trip_documents_v1_trips_trip__trip_id__documents_get"}],"panels":[]}]},"httpPath":"/v1/trips/trip/{trip_id}/documents"}],"content":{"contentType":"group","meta":{"name":"API / Trip"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"API / Trip","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/trips/trip/{trip_id}","summary":"Get Trip By Id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-trip/get_trip_by_id_v1_trips_trip__trip_id__get","deprecated":false},{"title":"/v1/trips/trip/{trip_id}/costs","summary":"Get Trip Costs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-trip/get_trip_costs_v1_trips_trip__trip_id__costs_get","deprecated":false},{"title":"/v1/trips/trip/{trip_id}/documents","summary":"Get Trip Documents","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-trip/get_trip_documents_v1_trips_trip__trip_id__documents_get","deprecated":false}]}]}]}]}},{"type":"separator","label":"System","content":null},{"type":"group","label":"System","link":"/docs/system","routeSlug":"/docs/system","items":[{"label":"Who Am I","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/system/who_am_i_me_get","routeSlug":"/docs/system/who_am_i_me_get","metadata":{"seo":{"title":"Who Am I","description":"Who Am I"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"who_am_i_me_get","name":"Who Am I","isWebhook":false,"pointer":"/paths/~1me/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Who Am I","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth2ClientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/me","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500","503"],"pointer":"/me","href":"system/who_am_i_me_get","openApiOperationId":"who_am_i_me_get","summary":"Who Am I"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_160"}},"schemaId":"schema_160"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1me/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_160","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_160"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/system/who_am_i_me_get"}],"panels":[]}]},"httpPath":"/me"}],"content":{"contentType":"group","meta":{"name":"System"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"System","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/me","summary":"Who Am I","prefix":{"name":"get","color":"get"},"badges":[],"link":"/system/who_am_i_me_get","deprecated":false}]}]}]}]}},{"type":"separator","label":"Webhooks","content":null},{"type":"group","label":"Webhooks / Inbound","link":"/docs/webhooks-inbound","routeSlug":"/docs/webhooks-inbound","items":[{"label":"External Billing Document (Invoice/Credit-Note) Update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/webhooks-inbound/billing-document-update-webhook","routeSlug":"/docs/webhooks-inbound/billing-document-update-webhook","metadata":{"seo":{"title":"External Billing Document (Invoice/Credit-Note) Update","description":"Update billing document metadata (invoices, credit notes) from an external accounting system."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"billing-document-update-webhook","name":"External Billing Document (Invoice/Credit-Note) Update","isWebhook":false,"pointer":"/paths/~1v1~1webhook~1billing-document-update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"External Billing Document (Invoice/Credit-Note) Update","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":"Update billing document metadata (invoices, credit notes) from an external accounting system."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This webhook uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Basic Auth"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (webhook credentials), not the OAuth credentials used for the API."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact integrations@qargo.com to request credentials."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint to push document status changes or related metadata updates back to Qargo."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is typically triggered when your external accounting system processes billing documents."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuthWebhookCredentials","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BillingDocumentUpdatePayload"}},"schemaId":"components/schemas/BillingDocumentUpdatePayload","pointer":"/paths/~1v1~1webhook~1billing-document-update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/webhook/billing-document-update","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuthWebhookCredentials","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BillingDocumentUpdatePayload"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/webhook/billing-document-update","href":"webhooks-inbound/billing-document-update-webhook","openApiOperationId":"billing-document-update-webhook","summary":"External Billing Document (Invoice/Credit-Note) Update"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/BillingDocumentUpdatePayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BillingDocumentUpdatePayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}},"schemaId":"schema_106"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1webhook~1billing-document-update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_106","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks-inbound/billing-document-update-webhook"}],"panels":[]}]},"httpPath":"/v1/webhook/billing-document-update"},{"label":"Generic Document Import","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/webhooks-inbound/document-import-webhook","routeSlug":"/docs/webhooks-inbound/document-import-webhook","metadata":{"seo":{"title":"Generic Document Import","description":"Webhook for importing documents and attaching them to existing orders in Qargo."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"document-import-webhook","name":"Generic Document Import","isWebhook":false,"pointer":"/paths/~1v1~1webhook~1document-import/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generic Document Import","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":"Webhook for importing documents and attaching them to existing orders in Qargo."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/document-import-webhook/request/use-case-document-import/document-import-webhook/request/how-it-works","deepLinkHash":"/webhooks-inbound/document-import-webhook#webhooks-inbound/document-import-webhook/request/use-case-document-import/document-import-webhook/request/how-it-works"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How it works"},"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":"An external system sends a file to this endpoint with metadata as query parameters."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system matches the document to an order in Qargo using the provided query parameters."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The document is created and attached to the matched order."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/document-import-webhook/request/use-case-document-import/document-import-webhook/request/query-parameters","deepLinkHash":"/webhooks-inbound/document-import-webhook#webhooks-inbound/document-import-webhook/request/use-case-document-import/document-import-webhook/request/query-parameters"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query parameters"},"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":"filename"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is always required. Additional query parameters are "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"configurable"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"per integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" during setup and are used to pass metadata about the file and to match"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the document to an order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query parameters can carry two types of information:"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"webhooks-inbound/document-import-webhook/request/use-case-document-import/document-import-webhook/request/file-metadata","deepLinkHash":"/webhooks-inbound/document-import-webhook#webhooks-inbound/document-import-webhook/request/use-case-document-import/document-import-webhook/request/file-metadata"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File metadata"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information about the document itself, for example:"},"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":"code","inline":true,"attributes":{"content":"filename"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (required) — Name of the uploaded file including extension"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"document_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — The type of document, see the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document types"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section below"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"document_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Display name for the document in Qargo"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"webhooks-inbound/document-import-webhook/request/use-case-document-import/document-import-webhook/request/matching-to-qargo-orders","deepLinkHash":"/webhooks-inbound/document-import-webhook#webhooks-inbound/document-import-webhook/request/use-case-document-import/document-import-webhook/request/matching-to-qargo-orders"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Matching to Qargo orders"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information used to resolve which order the document should be attached to."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following order fields can be matched against:"},"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":"code","inline":true,"attributes":{"content":"customer_reference_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — The customer reference number on the order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — The order name (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OR-12345"},"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":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — The order UUID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The match must resolve to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"exactly one order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If no order or multiple orders match,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the import will be discarded."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The actual set of query parameters and how they map to the above is configured per integration."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/document-import-webhook/request/use-case-document-import/document-import-webhook/request/document-types","deepLinkHash":"/webhooks-inbound/document-import-webhook#webhooks-inbound/document-import-webhook/request/use-case-document-import/document-import-webhook/request/document-types"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document types"},"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":"document_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter must be one of the following values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document type"},"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":"code","inline":true,"attributes":{"content":"ADDRESS_LABEL"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ANALYSIS_CERTIFICATE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ANNEX_VII_WASTE_SHIPMENT"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPROVAL_LOADING_LIST"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ATR"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AUTHORIZATION_PREFERENTIAL_ORIGIN"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BILL_OF_LADING_INSTRUCTIONS"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CATTLE_TRANSPORT_JOURNAL"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CERTIFICATE_OF_ORIGIN"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CERTIFICATE_OF_SHIPMENT"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CLAIM"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CMR_INSURANCE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMMERCIAL_INVOICE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONFIRMATION_TARIFF_SHIPPING_LINE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONSIGNEE_SIGNATURE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONSIGNOR_SIGNATURE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONTAINER_CLEANING_CERTIFICATE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CUSTOMER_PAPERWORK"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CUSTOMS_DECLARATION_INSTRUCTIONS"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CUSTOMS_DOCUMENT"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CUSTOMS_INVOICE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DANGEROUS_GOODS_DECLARATION"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEFENSE_MUNITIONS_VEHICLE_STABLING_REQUEST_FORM"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DISPATCH_CONFIRMATION"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DRAFT_BILL_OF_LADING"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DRIVER_SIGNATURE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DUTCH_CUSTOMS_RELEASE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EQUIPMENT_INTERCHANGE_RECEIPT"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EUR1"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EUR_MED"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXPORT_ACCOMPANYING_DOCUMENT"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXPORT_DECLARATION"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXPORT_DOCUMENT"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXTRA_COST_CONFIRMATION"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXTRA_PERMITTED_WEIGHT"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EX_A_EXPORT_DECLARATION"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINAL_BILL_OF_LADING"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GOODS_IN"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GOODS_OUT"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GPS_TRACKER_REPORT"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IFP"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IMDG"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IMPORT_DECLARATION"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IMPORT_DOCUMENT"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IM_A"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INSURANCE_DOCUMENT"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LOCATION_INFO"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LUMPER_RECEIPT"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MANIFEST"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MULTIMODAL_DANGEROUS_GOODS_DECL"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ORDER_ACCEPTANCE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ORDER_CONFIRMATION"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ORIGINAL_CMR"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OTHER_ADMINISTRATION"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PALLET_LABEL"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PALLET_LABEL_EXTERNAL"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PALLET_NOTE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PHOTO_DAMAGED_GOODS"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PHOTO_OF_GOODS_DELIVERY"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PHOTO_OF_GOODS_PICKUP"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PHOTO_SEAL_NUMBER"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PICKUP_CMR"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PICKUP_NOTE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PREFILLED_CMR"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRICE_OFFER_CUSTOMER"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROOF_OF_DELIVERY"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROOF_OF_DELIVERY_DRIVER_APP"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROOF_OF_DELIVERY_SIGNED"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROOF_OF_PICKUP"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROOF_OF_PICKUP_SIGNED"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUOTE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECEIPT"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAFETY_SECURITY_DECLARATION"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SECURITY_PLAN_FORM"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SINGLE_ADMINISTRATIVE_DOCUMENT"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STANDARD_OPERATING_PROCEDURE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STICKER_LABEL"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"T1_DOCUMENT"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"T2_DOCUMENT"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TEMPERATURE_REPORT"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TIMESLOT_CONFIRMATION"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRANSIT_DOCUMENT"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UK_EXPORTER_DRA"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UK_IMPORTER_DRA"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VGM_CONTAINER"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VISITOR_SAFETY_INSTRUCTION"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WAITING_HOURS_INFORMATION"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WASTE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WAYBILL"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WEIGHING_TICKET"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/document-import-webhook/request/use-case-document-import/document-import-webhook/request/content-encoding","deepLinkHash":"/webhooks-inbound/document-import-webhook#webhooks-inbound/document-import-webhook/request/use-case-document-import/document-import-webhook/request/content-encoding"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content encoding"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content format"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content-Type header"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior"},"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":"text","inline":true,"attributes":{"content":"Binary (e.g. PDF, image)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/png"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", etc."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Passed through as-is"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Text"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/xml"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", etc."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Encoded as UTF-8 bytes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base64-encoded string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Non-text or no header"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base64 decode attempted; raw string used on failure"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header matching the file format."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/document-import-webhook/request/use-case-document-import/document-import-webhook/request/error-handling","deepLinkHash":"/webhooks-inbound/document-import-webhook#webhooks-inbound/document-import-webhook/request/use-case-document-import/document-import-webhook/request/error-handling"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error handling"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scenario"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior"},"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":"text","inline":true,"attributes":{"content":"No order matches the provided criteria"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Import is discarded"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple orders match the criteria"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Import is discarded"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document metadata not provided"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Import is discarded"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuthWebhookCredentials","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filename","in":"query","schemaId":"schema_118","description":"Name of the file being uploaded, including extension. This is used as the primary source for the file name in Qargo.","required":true}],"pointer":"/paths/~1v1~1webhook~1document-import/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_119"}},"schemaId":"schema_119","pointer":"/paths/~1v1~1webhook~1document-import/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/webhook/document-import","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[{"name":"filename","in":"query","required":true,"schemaId":"schema_118"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuthWebhookCredentials","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_119"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/webhook/document-import","href":"webhooks-inbound/document-import-webhook","openApiOperationId":"document-import-webhook","summary":"Generic Document Import"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"schema_119","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_119"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentImportResponse"}},"schemaId":"components/schemas/DocumentImportResponse"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1webhook~1document-import/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DocumentImportResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentImportResponse"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks-inbound/document-import-webhook"}],"panels":[]}]},"httpPath":"/v1/webhook/document-import"},{"label":"External Document Upload From A Fleet Application","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/webhooks-inbound/fleet-document-upload-webhook","routeSlug":"/docs/webhooks-inbound/fleet-document-upload-webhook","metadata":{"seo":{"title":"External Document Upload From A Fleet Application","description":"Upload a document to a specific stop or stop group on a fleet-dispatched trip."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"fleet-document-upload-webhook","name":"External Document Upload From A Fleet Application","isWebhook":false,"pointer":"/paths/~1v1~1webhook~1fleet-document-upload/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"External Document Upload From A Fleet Application","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":"Upload a document to a specific stop or stop group on a fleet-dispatched trip."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This webhook uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Basic Auth"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (webhook credentials), not the OAuth credentials used for the API."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact integrations@qargo.com to request credentials."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/fleet-document-upload-webhook/request/use-case-fleet-dispatch/fleet-document-upload-webhook/request/use-case-document-import/fleet-document-upload-webhook/request/query-parameters","deepLinkHash":"/webhooks-inbound/fleet-document-upload-webhook#webhooks-inbound/fleet-document-upload-webhook/request/use-case-fleet-dispatch/fleet-document-upload-webhook/request/use-case-document-import/fleet-document-upload-webhook/request/query-parameters"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query parameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"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":"code","inline":true,"attributes":{"content":"question_path_key"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maps the file to a document type in Qargo (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CMR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WEIGHT_NOTE"},"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":"code","inline":true,"attributes":{"content":"stop_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No*"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Qargo UUID of the stop to attach the document to"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop_group_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No*"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Qargo UUID of the stop group to attach the document to"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"*Provide either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop_group_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to identify where to attach the document."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/fleet-document-upload-webhook/request/use-case-fleet-dispatch/fleet-document-upload-webhook/request/use-case-document-import/fleet-document-upload-webhook/request/headers","deepLinkHash":"/webhooks-inbound/fleet-document-upload-webhook#webhooks-inbound/fleet-document-upload-webhook/request/use-case-fleet-dispatch/fleet-document-upload-webhook/request/use-case-document-import/fleet-document-upload-webhook/request/headers"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Headers"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Header"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"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":"code","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":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MIME type of the file (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/jpeg"},"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":"code","inline":true,"attributes":{"content":"Content-Disposition"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provides the filename: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachment; filename=\"POD.pdf\""},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/fleet-document-upload-webhook/request/use-case-fleet-dispatch/fleet-document-upload-webhook/request/use-case-document-import/fleet-document-upload-webhook/request/filename-handling","deepLinkHash":"/webhooks-inbound/fleet-document-upload-webhook#webhooks-inbound/fleet-document-upload-webhook/request/use-case-fleet-dispatch/fleet-document-upload-webhook/request/use-case-document-import/fleet-document-upload-webhook/request/filename-handling"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filename handling"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The uploaded file's name in Qargo is determined by:"},"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":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Disposition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" includes a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filename"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — that value is used, combined with the question path key default."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filename=\"pod1234.pdf\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with question path key default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POD.pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → stored as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pod1234_POD.pdf"},"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":"If no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Disposition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided — the default filename from the question path key configuration is used."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/fleet-document-upload-webhook/request/use-case-fleet-dispatch/fleet-document-upload-webhook/request/use-case-document-import/fleet-document-upload-webhook/request/example","deepLinkHash":"/webhooks-inbound/fleet-document-upload-webhook#webhooks-inbound/fleet-document-upload-webhook/request/use-case-fleet-dispatch/fleet-document-upload-webhook/request/use-case-document-import/fleet-document-upload-webhook/request/example"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -X POST \\\n  \"https://api.qargo.com/v1/webhook/fleet-document-upload\\\n  ?question_path_key=POD&stop_id=<stop_uuid>\" \\\n  -u \"<webhook_client_id>:<webhook_secret_id>\" \\\n  -H \"Content-Type: application/pdf\" \\\n  -H \"Content-Disposition: attachment; filename=POD.pdf\" \\\n  --data-binary @/path/to/document.pdf\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -X POST \\\n  \"https://api.qargo.com/v1/webhook/fleet-document-upload\\\n  ?question_path_key=POD&stop_id=<stop_uuid>\" \\\n  -u \"<webhook_client_id>:<webhook_secret_id>\" \\\n  -H \"Content-Type: application/pdf\" \\\n  -H \"Content-Disposition: attachment; filename=POD.pdf\" \\\n  --data-binary @/path/to/document.pdf\n"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuthWebhookCredentials","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"question_path_key","in":"query","schemaId":"schema_120","description":"The question path key to map the file in Qargo, for example: CMR/POD","required":true},{"name":"stop_id","in":"query","schemaId":"schema_121","description":"The stop ID to which the document is related"},{"name":"stop_group_id","in":"query","schemaId":"schema_122","description":"The stop group ID to which the document is related"}],"pointer":"/paths/~1v1~1webhook~1fleet-document-upload/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_123"}},"schemaId":"schema_123","pointer":"/paths/~1v1~1webhook~1fleet-document-upload/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/webhook/fleet-document-upload","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[{"name":"question_path_key","in":"query","required":true,"schemaId":"schema_120"},{"name":"stop_id","in":"query","required":false,"schemaId":"schema_121"},{"name":"stop_group_id","in":"query","required":false,"schemaId":"schema_122"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuthWebhookCredentials","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_123"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/webhook/fleet-document-upload","href":"webhooks-inbound/fleet-document-upload-webhook","openApiOperationId":"fleet-document-upload-webhook","summary":"External Document Upload From A Fleet Application"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"schema_123","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_123"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}},"schemaId":"schema_106"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1webhook~1fleet-document-upload/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_106","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks-inbound/fleet-document-upload-webhook"}],"panels":[]}]},"httpPath":"/v1/webhook/fleet-document-upload"},{"label":"External Document Update With Payload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/webhooks-inbound/subcontractor-document-upload-webhook","routeSlug":"/docs/webhooks-inbound/subcontractor-document-upload-webhook","metadata":{"seo":{"title":"External Document Update With Payload","description":"Upload a document to a specific stop on a subcontracted trip."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"subcontractor-document-upload-webhook","name":"External Document Update With Payload","isWebhook":false,"pointer":"/paths/~1v1~1webhook~1subco-document-upload/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"External Document Update With Payload","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":"Upload a document to a specific stop on a subcontracted trip."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This webhook uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Basic Auth"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (webhook credentials), not the OAuth credentials used for the API."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact integrations@qargo.com to request credentials."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/subcontractor-document-upload-webhook/request/use-case-subcontractor-dispatch/subcontractor-document-upload-webhook/request/use-case-document-import/subcontractor-document-upload-webhook/request/query-parameters","deepLinkHash":"/webhooks-inbound/subcontractor-document-upload-webhook#webhooks-inbound/subcontractor-document-upload-webhook/request/use-case-subcontractor-dispatch/subcontractor-document-upload-webhook/request/use-case-document-import/subcontractor-document-upload-webhook/request/query-parameters"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query parameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"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":"code","inline":true,"attributes":{"content":"question_path_key"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maps the file to a document type in Qargo (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CMR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WEIGHT_NOTE"},"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":"code","inline":true,"attributes":{"content":"stop_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Qargo UUID of the stop to attach the document to"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/subcontractor-document-upload-webhook/request/use-case-subcontractor-dispatch/subcontractor-document-upload-webhook/request/use-case-document-import/subcontractor-document-upload-webhook/request/headers","deepLinkHash":"/webhooks-inbound/subcontractor-document-upload-webhook#webhooks-inbound/subcontractor-document-upload-webhook/request/use-case-subcontractor-dispatch/subcontractor-document-upload-webhook/request/use-case-document-import/subcontractor-document-upload-webhook/request/headers"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Headers"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Header"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"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":"code","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":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MIME type of the file (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/jpeg"},"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":"code","inline":true,"attributes":{"content":"Content-Disposition"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provides the filename: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachment; filename=\"POD.pdf\""},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/subcontractor-document-upload-webhook/request/use-case-subcontractor-dispatch/subcontractor-document-upload-webhook/request/use-case-document-import/subcontractor-document-upload-webhook/request/filename-handling","deepLinkHash":"/webhooks-inbound/subcontractor-document-upload-webhook#webhooks-inbound/subcontractor-document-upload-webhook/request/use-case-subcontractor-dispatch/subcontractor-document-upload-webhook/request/use-case-document-import/subcontractor-document-upload-webhook/request/filename-handling"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filename handling"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The uploaded file's name in Qargo is determined by:"},"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":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Disposition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" includes a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filename"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — that value is used, combined with the question path key default."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filename=\"pod1234.pdf\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with question path key default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POD.pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → stored as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pod1234_POD.pdf"},"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":"If no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Disposition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided — the default filename from the question path key configuration is used."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/subcontractor-document-upload-webhook/request/use-case-subcontractor-dispatch/subcontractor-document-upload-webhook/request/use-case-document-import/subcontractor-document-upload-webhook/request/example","deepLinkHash":"/webhooks-inbound/subcontractor-document-upload-webhook#webhooks-inbound/subcontractor-document-upload-webhook/request/use-case-subcontractor-dispatch/subcontractor-document-upload-webhook/request/use-case-document-import/subcontractor-document-upload-webhook/request/example"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -X POST \\\n  \"https://api.qargo.com/v1/webhook/subco-document-upload\\\n  ?question_path_key=POD&stop_id=<stop_uuid>\" \\\n  -u \"<webhook_client_id>:<webhook_secret_id>\" \\\n  -H \"Content-Type: application/pdf\" \\\n  -H \"Content-Disposition: attachment; filename=POD.pdf\" \\\n  --data-binary @/path/to/document.pdf\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -X POST \\\n  \"https://api.qargo.com/v1/webhook/subco-document-upload\\\n  ?question_path_key=POD&stop_id=<stop_uuid>\" \\\n  -u \"<webhook_client_id>:<webhook_secret_id>\" \\\n  -H \"Content-Type: application/pdf\" \\\n  -H \"Content-Disposition: attachment; filename=POD.pdf\" \\\n  --data-binary @/path/to/document.pdf\n"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuthWebhookCredentials","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"question_path_key","in":"query","schemaId":"schema_120","description":"The question path key to map the file in Qargo, for example: CMR/POD","required":true},{"name":"stop_id","in":"query","schemaId":"schema_124","description":"The stop ID to which the document is related","required":true}],"pointer":"/paths/~1v1~1webhook~1subco-document-upload/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_123"}},"schemaId":"schema_123","pointer":"/paths/~1v1~1webhook~1subco-document-upload/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/webhook/subco-document-upload","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[{"name":"question_path_key","in":"query","required":true,"schemaId":"schema_120"},{"name":"stop_id","in":"query","required":true,"schemaId":"schema_124"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuthWebhookCredentials","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_123"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/webhook/subco-document-upload","href":"webhooks-inbound/subcontractor-document-upload-webhook","openApiOperationId":"subcontractor-document-upload-webhook","summary":"External Document Update With Payload"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"schema_123","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_123"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}},"schemaId":"schema_106"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1webhook~1subco-document-upload/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_106","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks-inbound/subcontractor-document-upload-webhook"}],"panels":[]}]},"httpPath":"/v1/webhook/subco-document-upload"},{"label":"Send E-Invoices","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/webhooks-inbound/e-invoicing-webhook","routeSlug":"/docs/webhooks-inbound/e-invoicing-webhook","metadata":{"seo":{"title":"Send E-Invoices","description":"Webhook to receive e-invoices in structured format or as file uploads."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"e-invoicing-webhook","name":"Send E-Invoices","isWebhook":false,"pointer":"/paths/~1v1~1webhook~1e-invoicing/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send E-Invoices","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":"Webhook to receive e-invoices in structured format or as file uploads."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/e-invoicing-webhook/request/use-case-e-invoicing/e-invoicing-webhook/request/supported-formats","deepLinkHash":"/webhooks-inbound/e-invoicing-webhook#webhooks-inbound/e-invoicing-webhook/request/use-case-e-invoicing/e-invoicing-webhook/request/supported-formats"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported Formats"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint accepts e-invoices in multiple formats:"},"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":"JSON payloads"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Structured data using application/json content type."},"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":"XML payloads"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Structured data using application/xml content type. Must be a valid UBL document."},"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":"File uploads"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": JSON + binary files (PDF, XML, etc.) using multipart/form-data."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/e-invoicing-webhook/request/use-case-e-invoicing/e-invoicing-webhook/request/multipart-upload-support","deepLinkHash":"/webhooks-inbound/e-invoicing-webhook#webhooks-inbound/e-invoicing-webhook/request/use-case-e-invoicing/e-invoicing-webhook/request/multipart-upload-support"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multipart Upload Support"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When using multipart form data, the endpoint expects:"},"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":"First part: JSON document (PurchaseEInvoiceInput or PurchaseECreditNoteInput). XML is not supported at the moment."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subsequent parts: Supporting documents (invoice PDF, CMR PDF, etc.)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/e-invoicing-webhook/request/use-case-e-invoicing/e-invoicing-webhook/request/examples","deepLinkHash":"/webhooks-inbound/e-invoicing-webhook#webhooks-inbound/e-invoicing-webhook/request/use-case-e-invoicing/e-invoicing-webhook/request/examples"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples"},"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":"JSON payload example (application/json)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"name\": \"INV-2023-001\",\n  \"date\": \"2023-01-15\",\n  \"due_date\": \"2023-02-15\",\n  \"invoice_type\": \"PURCHASE\",\n  \"currency\": \"EUR\",\n  \"total_excl_tax\": 999.99,\n  \"total_incl_tax\": 1209.99,\n  \"total_tax\": 210.00,\n  \"custom_fields\": {},\n  \"supplier\": {\n    \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n    \"name\": \"Supplier Company Ltd\",\n    \"vat_number\": \"BE1234.123.123\",\n    \"billing_location\": {\n      \"address\": \"Gaston Crommenlaan 4\",\n      \"city\": \"Gent\",\n      \"postal_code\": \"9050\",\n      \"country\": \"BE\"\n    }\n  },\n  \"customer_reference_numbers\": [\"12345\"],\n  \"line_items\": [\n    {\n      \"description\": \"International freight transport\",\n      \"amount\": 999.99,\n      \"currency\": \"EUR\",\n      \"tax_rate\": {\n        \"percentage\": 21.0,\n        \"name\": \"21% VAT\",\n        \"tax_type\": \"VAT\"\n      },\n      \"account\": {\n        \"code\": \"6000\"\n      },\n      \"references\": {\n        \"order_name\": \"OR-1234\"\n      }\n    }\n  ],\n  \"attachments\": [\n    {\n      \"document\": {\n        \"base64\": \"JVBERi0xLjQKJcfs... (truncated for brevity) ...\",\n        \"content_type\": \"application/pdf\",\n        \"document_type\": \"INVOICE\",\n        \"filename\": \"invoice_123.pdf\"\n      }\n    }\n  ]\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"name\": \"INV-2023-001\",\n  \"date\": \"2023-01-15\",\n  \"due_date\": \"2023-02-15\",\n  \"invoice_type\": \"PURCHASE\",\n  \"currency\": \"EUR\",\n  \"total_excl_tax\": 999.99,\n  \"total_incl_tax\": 1209.99,\n  \"total_tax\": 210.00,\n  \"custom_fields\": {},\n  \"supplier\": {\n    \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n    \"name\": \"Supplier Company Ltd\",\n    \"vat_number\": \"BE1234.123.123\",\n    \"billing_location\": {\n      \"address\": \"Gaston Crommenlaan 4\",\n      \"city\": \"Gent\",\n      \"postal_code\": \"9050\",\n      \"country\": \"BE\"\n    }\n  },\n  \"customer_reference_numbers\": [\"12345\"],\n  \"line_items\": [\n    {\n      \"description\": \"International freight transport\",\n      \"amount\": 999.99,\n      \"currency\": \"EUR\",\n      \"tax_rate\": {\n        \"percentage\": 21.0,\n        \"name\": \"21% VAT\",\n        \"tax_type\": \"VAT\"\n      },\n      \"account\": {\n        \"code\": \"6000\"\n      },\n      \"references\": {\n        \"order_name\": \"OR-1234\"\n      }\n    }\n  ],\n  \"attachments\": [\n    {\n      \"document\": {\n        \"base64\": \"JVBERi0xLjQKJcfs... (truncated for brevity) ...\",\n        \"content_type\": \"application/pdf\",\n        \"document_type\": \"INVOICE\",\n        \"filename\": \"invoice_123.pdf\"\n      }\n    }\n  ]\n}\n"},"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":"Credit note example (application/json)."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Note: credit notes do not have a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"due_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"name\": \"CN-2023-001\",\n  \"date\": \"2023-03-01\",\n  \"invoice_type\": \"PURCHASE_CREDIT_NOTE\",\n  \"currency\": \"EUR\",\n  \"total_excl_tax\": -200.00,\n  \"total_incl_tax\": -242.00,\n  \"total_tax\": -42.00,\n  \"supplier\": {\n    \"name\": \"Supplier Company Ltd\",\n    \"vat_number\": \"BE1234.123.123\"\n  },\n  \"customer_reference_numbers\": [\"12345\"],\n  \"line_items\": [\n    {\n      \"amount\": -200.00,\n      \"currency\": \"EUR\",\n      \"tax_rate\": {\n        \"percentage\": 21.0,\n        \"tax_type\": \"VAT\"\n      },\n      \"account\": {\n        \"code\": \"6000\"\n      }\n    }\n  ]\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"name\": \"CN-2023-001\",\n  \"date\": \"2023-03-01\",\n  \"invoice_type\": \"PURCHASE_CREDIT_NOTE\",\n  \"currency\": \"EUR\",\n  \"total_excl_tax\": -200.00,\n  \"total_incl_tax\": -242.00,\n  \"total_tax\": -42.00,\n  \"supplier\": {\n    \"name\": \"Supplier Company Ltd\",\n    \"vat_number\": \"BE1234.123.123\"\n  },\n  \"customer_reference_numbers\": [\"12345\"],\n  \"line_items\": [\n    {\n      \"amount\": -200.00,\n      \"currency\": \"EUR\",\n      \"tax_rate\": {\n        \"percentage\": 21.0,\n        \"tax_type\": \"VAT\"\n      },\n      \"account\": {\n        \"code\": \"6000\"\n      }\n    }\n  ]\n}\n"},"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":"XML payload example (application/xml)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<Invoice xmlns=\"urn:oasis:names:specification:ubl:schema:xsd:Invoice-2\" xmlns:cac=\"urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2\" xmlns:cbc=\"urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2\" xmlns:ccts=\"urn:un:unece:uncefact:documentation:2\" xmlns:ext=\"urn:oasis:names:specification:ubl:schema:xsd:CommonExtensionComponents-2\" xmlns:qdt=\"urn:oasis:names:specification:ubl:schema:xsd:QualifiedDatatypes-2\" xmlns:udt=\"urn:un:unece:uncefact:data:specification:UnqualifiedDataTypesSchemaModule:2\">\n    <cbc:CustomizationID>urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0</cbc:CustomizationID>\n    <cbc:ProfileID>urn:fdc:peppol.eu:2017:poacc:billing:01:1.0</cbc:ProfileID>\n    <cbc:ID>25900027</cbc:ID>\n    <cbc:IssueDate>2025-10-28</cbc:IssueDate>\n    <cbc:DueDate>2025-10-28</cbc:DueDate>\n    <cbc:InvoiceTypeCode>380</cbc:InvoiceTypeCode>\n    <cbc:DocumentCurrencyCode>EUR</cbc:DocumentCurrencyCode>\n    <cbc:BuyerReference>25900027</cbc:BuyerReference>\n    <cac:AdditionalDocumentReference>\n        <cbc:ID>600947</cbc:ID>\n        <cac:Attachment>\n            <cbc:EmbeddedDocumentBinaryObject mimeCode=\"application/pdf\" filename=\"25900027.pdf\">JVBERi0xLjQKJcfs... (truncated for brevity) ...</cbc:EmbeddedDocumentBinaryObject>\n        </cac:Attachment>\n    </cac:AdditionalDocumentReference>\n    <cac:AccountingSupplierParty>\n        <cac:Party>\n        <cbc:EndpointID schemeID=\"0208\">0564730040</cbc:EndpointID>\n        <cac:PartyName>\n            <cbc:Name>qargo-peppol-dev</cbc:Name>\n        </cac:PartyName>\n        <cac:PostalAddress>\n            <cbc:StreetName>Gaston Crommenlaan 4</cbc:StreetName>\n            <cbc:CityName>Gent</cbc:CityName>\n            <cbc:PostalZone>9050</cbc:PostalZone>\n            <cbc:CountrySubentity>Oost-Vlaanderen</cbc:CountrySubentity>\n            <cac:Country>\n            <cbc:IdentificationCode>BE</cbc:IdentificationCode>\n            </cac:Country>\n        </cac:PostalAddress>\n        <cac:PartyTaxScheme>\n            <cbc:CompanyID>BE0772640434</cbc:CompanyID>\n            <cac:TaxScheme>\n            <cbc:ID>VAT</cbc:ID>\n            </cac:TaxScheme>\n        </cac:PartyTaxScheme>\n        <cac:PartyLegalEntity>\n            <cbc:RegistrationName>qargo-peppol-dev</cbc:RegistrationName>\n            <cbc:CompanyID schemeID=\"0208\">0564730040</cbc:CompanyID>\n        </cac:PartyLegalEntity>\n        <cac:Contact>\n            <cbc:Telephone>+324854244512</cbc:Telephone>\n            <cbc:ElectronicMail>simon@qargo.com</cbc:ElectronicMail>\n        </cac:Contact>\n        </cac:Party>\n    </cac:AccountingSupplierParty>\n    <cac:AccountingCustomerParty>\n        <cac:Party>\n        <cbc:EndpointID schemeID=\"0208\">0772640434</cbc:EndpointID>\n        <cac:PartyName>\n            <cbc:Name>Qargo</cbc:Name>\n        </cac:PartyName>\n        <cac:PostalAddress>\n            <cbc:StreetName>Gaston Crommenlaan 4</cbc:StreetName>\n            <cbc:CityName>Gent</cbc:CityName>\n            <cbc:PostalZone>9050</cbc:PostalZone>\n            <cac:Country>\n            <cbc:IdentificationCode>BE</cbc:IdentificationCode>\n            </cac:Country>\n        </cac:PostalAddress>\n        <cac:PartyLegalEntity>\n            <cbc:RegistrationName languageID=\"nl\">Qargo</cbc:RegistrationName>\n            <cbc:CompanyID schemeID=\"0208\">0772640434</cbc:CompanyID>\n        </cac:PartyLegalEntity>\n        </cac:Party>\n    </cac:AccountingCustomerParty>\n    <cac:TaxTotal>\n        <cbc:TaxAmount currencyID=\"EUR\">162.71</cbc:TaxAmount>\n        <cac:TaxSubtotal>\n        <cbc:TaxableAmount currencyID=\"EUR\">774.83</cbc:TaxableAmount>\n        <cbc:TaxAmount currencyID=\"EUR\">162.71</cbc:TaxAmount>\n        <cac:TaxCategory>\n            <cbc:ID>S</cbc:ID>\n            <cbc:Percent>21.00</cbc:Percent>\n            <cac:TaxScheme>\n            <cbc:ID>VAT</cbc:ID>\n            </cac:TaxScheme>\n        </cac:TaxCategory>\n        </cac:TaxSubtotal>\n    </cac:TaxTotal>\n    <cac:LegalMonetaryTotal>\n        <cbc:LineExtensionAmount currencyID=\"EUR\">774.83</cbc:LineExtensionAmount>\n        <cbc:TaxExclusiveAmount currencyID=\"EUR\">774.83</cbc:TaxExclusiveAmount>\n        <cbc:TaxInclusiveAmount currencyID=\"EUR\">937.54</cbc:TaxInclusiveAmount>\n        <cbc:PayableAmount currencyID=\"EUR\">937.54</cbc:PayableAmount>\n    </cac:LegalMonetaryTotal>\n    <cac:InvoiceLine>\n        <cbc:ID>1</cbc:ID>\n        <cbc:InvoicedQuantity unitCode=\"EA\">1.0</cbc:InvoicedQuantity>\n        <cbc:LineExtensionAmount currencyID=\"EUR\">65.00</cbc:LineExtensionAmount>\n        <cac:Item>\n        <cbc:Name>Administratiekost</cbc:Name>\n        <cac:ClassifiedTaxCategory>\n            <cbc:ID>S</cbc:ID>\n            <cbc:Percent>21.00</cbc:Percent>\n            <cac:TaxScheme>\n            <cbc:ID>VAT</cbc:ID>\n            </cac:TaxScheme>\n        </cac:ClassifiedTaxCategory>\n        </cac:Item>\n        <cac:Price>\n        <cbc:PriceAmount currencyID=\"EUR\">65.0</cbc:PriceAmount>\n        </cac:Price>\n    </cac:InvoiceLine>\n    <cac:InvoiceLine>\n        <cbc:ID>2</cbc:ID>\n        <cbc:InvoicedQuantity unitCode=\"EA\">1.0</cbc:InvoicedQuantity>\n        <cbc:LineExtensionAmount currencyID=\"EUR\">709.83</cbc:LineExtensionAmount>\n        <cac:Item>\n        <cbc:Name>Transport charge</cbc:Name>\n        <cac:ClassifiedTaxCategory>\n            <cbc:ID>S</cbc:ID>\n            <cbc:Percent>21.00</cbc:Percent>\n            <cac:TaxScheme>\n            <cbc:ID>VAT</cbc:ID>\n            </cac:TaxScheme>\n        </cac:ClassifiedTaxCategory>\n        </cac:Item>\n        <cac:Price>\n        <cbc:PriceAmount currencyID=\"EUR\">709.83</cbc:PriceAmount>\n        </cac:Price>\n    </cac:InvoiceLine>\n</Invoice>\n","language":"xml"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<Invoice xmlns=\"urn:oasis:names:specification:ubl:schema:xsd:Invoice-2\" xmlns:cac=\"urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2\" xmlns:cbc=\"urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2\" xmlns:ccts=\"urn:un:unece:uncefact:documentation:2\" xmlns:ext=\"urn:oasis:names:specification:ubl:schema:xsd:CommonExtensionComponents-2\" xmlns:qdt=\"urn:oasis:names:specification:ubl:schema:xsd:QualifiedDatatypes-2\" xmlns:udt=\"urn:un:unece:uncefact:data:specification:UnqualifiedDataTypesSchemaModule:2\">\n    <cbc:CustomizationID>urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0</cbc:CustomizationID>\n    <cbc:ProfileID>urn:fdc:peppol.eu:2017:poacc:billing:01:1.0</cbc:ProfileID>\n    <cbc:ID>25900027</cbc:ID>\n    <cbc:IssueDate>2025-10-28</cbc:IssueDate>\n    <cbc:DueDate>2025-10-28</cbc:DueDate>\n    <cbc:InvoiceTypeCode>380</cbc:InvoiceTypeCode>\n    <cbc:DocumentCurrencyCode>EUR</cbc:DocumentCurrencyCode>\n    <cbc:BuyerReference>25900027</cbc:BuyerReference>\n    <cac:AdditionalDocumentReference>\n        <cbc:ID>600947</cbc:ID>\n        <cac:Attachment>\n            <cbc:EmbeddedDocumentBinaryObject mimeCode=\"application/pdf\" filename=\"25900027.pdf\">JVBERi0xLjQKJcfs... (truncated for brevity) ...</cbc:EmbeddedDocumentBinaryObject>\n        </cac:Attachment>\n    </cac:AdditionalDocumentReference>\n    <cac:AccountingSupplierParty>\n        <cac:Party>\n        <cbc:EndpointID schemeID=\"0208\">0564730040</cbc:EndpointID>\n        <cac:PartyName>\n            <cbc:Name>qargo-peppol-dev</cbc:Name>\n        </cac:PartyName>\n        <cac:PostalAddress>\n            <cbc:StreetName>Gaston Crommenlaan 4</cbc:StreetName>\n            <cbc:CityName>Gent</cbc:CityName>\n            <cbc:PostalZone>9050</cbc:PostalZone>\n            <cbc:CountrySubentity>Oost-Vlaanderen</cbc:CountrySubentity>\n            <cac:Country>\n            <cbc:IdentificationCode>BE</cbc:IdentificationCode>\n            </cac:Country>\n        </cac:PostalAddress>\n        <cac:PartyTaxScheme>\n            <cbc:CompanyID>BE0772640434</cbc:CompanyID>\n            <cac:TaxScheme>\n            <cbc:ID>VAT</cbc:ID>\n            </cac:TaxScheme>\n        </cac:PartyTaxScheme>\n        <cac:PartyLegalEntity>\n            <cbc:RegistrationName>qargo-peppol-dev</cbc:RegistrationName>\n            <cbc:CompanyID schemeID=\"0208\">0564730040</cbc:CompanyID>\n        </cac:PartyLegalEntity>\n        <cac:Contact>\n            <cbc:Telephone>+324854244512</cbc:Telephone>\n            <cbc:ElectronicMail>simon@qargo.com</cbc:ElectronicMail>\n        </cac:Contact>\n        </cac:Party>\n    </cac:AccountingSupplierParty>\n    <cac:AccountingCustomerParty>\n        <cac:Party>\n        <cbc:EndpointID schemeID=\"0208\">0772640434</cbc:EndpointID>\n        <cac:PartyName>\n            <cbc:Name>Qargo</cbc:Name>\n        </cac:PartyName>\n        <cac:PostalAddress>\n            <cbc:StreetName>Gaston Crommenlaan 4</cbc:StreetName>\n            <cbc:CityName>Gent</cbc:CityName>\n            <cbc:PostalZone>9050</cbc:PostalZone>\n            <cac:Country>\n            <cbc:IdentificationCode>BE</cbc:IdentificationCode>\n            </cac:Country>\n        </cac:PostalAddress>\n        <cac:PartyLegalEntity>\n            <cbc:RegistrationName languageID=\"nl\">Qargo</cbc:RegistrationName>\n            <cbc:CompanyID schemeID=\"0208\">0772640434</cbc:CompanyID>\n        </cac:PartyLegalEntity>\n        </cac:Party>\n    </cac:AccountingCustomerParty>\n    <cac:TaxTotal>\n        <cbc:TaxAmount currencyID=\"EUR\">162.71</cbc:TaxAmount>\n        <cac:TaxSubtotal>\n        <cbc:TaxableAmount currencyID=\"EUR\">774.83</cbc:TaxableAmount>\n        <cbc:TaxAmount currencyID=\"EUR\">162.71</cbc:TaxAmount>\n        <cac:TaxCategory>\n            <cbc:ID>S</cbc:ID>\n            <cbc:Percent>21.00</cbc:Percent>\n            <cac:TaxScheme>\n            <cbc:ID>VAT</cbc:ID>\n            </cac:TaxScheme>\n        </cac:TaxCategory>\n        </cac:TaxSubtotal>\n    </cac:TaxTotal>\n    <cac:LegalMonetaryTotal>\n        <cbc:LineExtensionAmount currencyID=\"EUR\">774.83</cbc:LineExtensionAmount>\n        <cbc:TaxExclusiveAmount currencyID=\"EUR\">774.83</cbc:TaxExclusiveAmount>\n        <cbc:TaxInclusiveAmount currencyID=\"EUR\">937.54</cbc:TaxInclusiveAmount>\n        <cbc:PayableAmount currencyID=\"EUR\">937.54</cbc:PayableAmount>\n    </cac:LegalMonetaryTotal>\n    <cac:InvoiceLine>\n        <cbc:ID>1</cbc:ID>\n        <cbc:InvoicedQuantity unitCode=\"EA\">1.0</cbc:InvoicedQuantity>\n        <cbc:LineExtensionAmount currencyID=\"EUR\">65.00</cbc:LineExtensionAmount>\n        <cac:Item>\n        <cbc:Name>Administratiekost</cbc:Name>\n        <cac:ClassifiedTaxCategory>\n            <cbc:ID>S</cbc:ID>\n            <cbc:Percent>21.00</cbc:Percent>\n            <cac:TaxScheme>\n            <cbc:ID>VAT</cbc:ID>\n            </cac:TaxScheme>\n        </cac:ClassifiedTaxCategory>\n        </cac:Item>\n        <cac:Price>\n        <cbc:PriceAmount currencyID=\"EUR\">65.0</cbc:PriceAmount>\n        </cac:Price>\n    </cac:InvoiceLine>\n    <cac:InvoiceLine>\n        <cbc:ID>2</cbc:ID>\n        <cbc:InvoicedQuantity unitCode=\"EA\">1.0</cbc:InvoicedQuantity>\n        <cbc:LineExtensionAmount currencyID=\"EUR\">709.83</cbc:LineExtensionAmount>\n        <cac:Item>\n        <cbc:Name>Transport charge</cbc:Name>\n        <cac:ClassifiedTaxCategory>\n            <cbc:ID>S</cbc:ID>\n            <cbc:Percent>21.00</cbc:Percent>\n            <cac:TaxScheme>\n            <cbc:ID>VAT</cbc:ID>\n            </cac:TaxScheme>\n        </cac:ClassifiedTaxCategory>\n        </cac:Item>\n        <cac:Price>\n        <cbc:PriceAmount currencyID=\"EUR\">709.83</cbc:PriceAmount>\n        </cac:Price>\n    </cac:InvoiceLine>\n</Invoice>\n"},"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":"Multipart Form Data example."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"POST /v1/webhook/e-invoicing\nContent-Type: multipart/form-data; boundary=----WebKitFormBoundaryABC123XYZ\n\n----WebKitFormBoundaryABC123XYZ\nContent-Disposition: form-data; name=\"document\"; filename=\"invoice_data.json\"\nContent-Type: application/json\n\n{\n  \"name\": \"INV-2023-001\",\n  \"date\": \"2023-01-15\",\n  \"due_date\": \"2023-02-15\",\n  \"invoice_type\": \"PURCHASE\",\n  \"currency\": \"EUR\",\n  \"total_excl_tax\": 999.99,\n  \"total_incl_tax\": 1209.99,\n  \"total_tax\": 210.00,\n  \"custom_fields\": {},\n  \"supplier\": {\n    \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n    \"name\": \"Supplier Company Ltd\",\n    \"vat_number\": \"BE1234.123.123\",\n    \"billing_location\": {\n      \"address\": \"Gaston Crommenlaan 4\",\n      \"city\": \"Gent\",\n      \"postal_code\": \"9050\",\n      \"country\": \"BE\"\n    }\n  },\n  \"customer_reference_numbers\": [\"12345\"],\n  \"line_items\": [\n    {\n      \"description\": \"International freight transport\",\n      \"amount\": 999.99,\n      \"currency\": \"EUR\",\n      \"tax_rate\": {\n        \"percentage\": 21.0,\n        \"name\": \"21% VAT\",\n        \"tax_type\": \"VAT\"\n      },\n      \"account\": {\n        \"code\": \"6000\"\n      },\n      \"references\": {\n        \"order_name\": \"OR-1234\"\n      }\n    }\n  ]\n}\n----WebKitFormBoundaryABC123XYZ\nContent-Disposition: form-data; name=\"invoice\"; filename=\"invoice_123.pdf\"\nContent-Type: application/pdf\n\n[binary PDF content]\n----WebKitFormBoundaryABC123XYZ\nContent-Disposition: form-data; name=\"cmr\"; filename=\"cmr_document.pdf\"\nContent-Type: application/pdf\n\n[binary PDF content]\n----WebKitFormBoundaryABC123XYZ--\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST /v1/webhook/e-invoicing\nContent-Type: multipart/form-data; boundary=----WebKitFormBoundaryABC123XYZ\n\n----WebKitFormBoundaryABC123XYZ\nContent-Disposition: form-data; name=\"document\"; filename=\"invoice_data.json\"\nContent-Type: application/json\n\n{\n  \"name\": \"INV-2023-001\",\n  \"date\": \"2023-01-15\",\n  \"due_date\": \"2023-02-15\",\n  \"invoice_type\": \"PURCHASE\",\n  \"currency\": \"EUR\",\n  \"total_excl_tax\": 999.99,\n  \"total_incl_tax\": 1209.99,\n  \"total_tax\": 210.00,\n  \"custom_fields\": {},\n  \"supplier\": {\n    \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n    \"name\": \"Supplier Company Ltd\",\n    \"vat_number\": \"BE1234.123.123\",\n    \"billing_location\": {\n      \"address\": \"Gaston Crommenlaan 4\",\n      \"city\": \"Gent\",\n      \"postal_code\": \"9050\",\n      \"country\": \"BE\"\n    }\n  },\n  \"customer_reference_numbers\": [\"12345\"],\n  \"line_items\": [\n    {\n      \"description\": \"International freight transport\",\n      \"amount\": 999.99,\n      \"currency\": \"EUR\",\n      \"tax_rate\": {\n        \"percentage\": 21.0,\n        \"name\": \"21% VAT\",\n        \"tax_type\": \"VAT\"\n      },\n      \"account\": {\n        \"code\": \"6000\"\n      },\n      \"references\": {\n        \"order_name\": \"OR-1234\"\n      }\n    }\n  ]\n}\n----WebKitFormBoundaryABC123XYZ\nContent-Disposition: form-data; name=\"invoice\"; filename=\"invoice_123.pdf\"\nContent-Type: application/pdf\n\n[binary PDF content]\n----WebKitFormBoundaryABC123XYZ\nContent-Disposition: form-data; name=\"cmr\"; filename=\"cmr_document.pdf\"\nContent-Type: application/pdf\n\n[binary PDF content]\n----WebKitFormBoundaryABC123XYZ--\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/e-invoicing-webhook/request/use-case-e-invoicing/e-invoicing-webhook/request/processing-notes-on-multipart-uploads","deepLinkHash":"/webhooks-inbound/e-invoicing-webhook#webhooks-inbound/e-invoicing-webhook/request/use-case-e-invoicing/e-invoicing-webhook/request/processing-notes-on-multipart-uploads"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processing Notes on Multipart Uploads"},"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":"First part must be the JSON document containing invoice/credit note data."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supporting documents follow as additional parts."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content-Type headers determine document processing."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuthWebhookCredentials","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_125"}},"schemaId":"schema_125","pointer":"/paths/~1v1~1webhook~1e-invoicing/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/webhook/e-invoicing","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuthWebhookCredentials","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_125"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/webhook/e-invoicing","href":"webhooks-inbound/e-invoicing-webhook","openApiOperationId":"e-invoicing-webhook","summary":"Send E-Invoices"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"schema_125","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_125"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}},"schemaId":"schema_106"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1webhook~1e-invoicing/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_106","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks-inbound/e-invoicing-webhook"}],"panels":[]}]},"httpPath":"/v1/webhook/e-invoicing"},{"label":"External Status Update From A Fleet Application","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/webhooks-inbound/fleet-status-update-webhook","routeSlug":"/docs/webhooks-inbound/fleet-status-update-webhook","metadata":{"seo":{"title":"External Status Update From A Fleet Application","description":"Webhook for updating the status, ETA, and data of stops from an external fleet application."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"fleet-status-update-webhook","name":"External Status Update From A Fleet Application","isWebhook":false,"pointer":"/paths/~1v1~1webhook~1fleet-status-update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"External Status Update From A Fleet Application","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":"Webhook for updating the status, ETA, and data of stops from an external fleet application."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that this webhook uses Basic Auth instead of the OAuth credentials used for the api."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please contact integrations@qargo.com to request credentials."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eta_start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eta_end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" date-time values must include a timezone offset,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2025-06-15T10:30:00Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2025-06-15T12:30:00+02:00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/fleet-status-update-webhook/request/use-case-fleet-dispatch/fleet-status-update-webhook/request/identifying-a-stop","deepLinkHash":"/webhooks-inbound/fleet-status-update-webhook#webhooks-inbound/fleet-status-update-webhook/request/use-case-fleet-dispatch/fleet-status-update-webhook/request/identifying-a-stop"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifying a stop"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each update targets either a single "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"stop"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"stop group"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Provide one per update entry."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"webhooks-inbound/fleet-status-update-webhook/request/use-case-fleet-dispatch/fleet-status-update-webhook/request/by-stop-id-(preferred)","deepLinkHash":"/webhooks-inbound/fleet-status-update-webhook#webhooks-inbound/fleet-status-update-webhook/request/use-case-fleet-dispatch/fleet-status-update-webhook/request/by-stop-id-(preferred)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By stop ID (preferred)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you know the Qargo stop UUID, pass it directly in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"updates\": [\n    {\n      \"stop\": { \"id\": \"a1b2c3d4-0000-0000-0000-000000000000\", \"status\": \"AT_STOP\" },\n      \"event_time\": \"2025-06-15T10:30:00Z\"\n    }\n  ]\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"updates\": [\n    {\n      \"stop\": { \"id\": \"a1b2c3d4-0000-0000-0000-000000000000\", \"status\": \"AT_STOP\" },\n      \"event_time\": \"2025-06-15T10:30:00Z\"\n    }\n  ]\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"webhooks-inbound/fleet-status-update-webhook/request/use-case-fleet-dispatch/fleet-status-update-webhook/request/by-matching-criteria","deepLinkHash":"/webhooks-inbound/fleet-status-update-webhook#webhooks-inbound/fleet-status-update-webhook/request/use-case-fleet-dispatch/fleet-status-update-webhook/request/by-matching-criteria"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By matching criteria"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the stop ID is not known, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop.match"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to find the stop by its related entities."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The matcher uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all provided criteria combined"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (AND logic) and expects "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"exactly one stop"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to match. If zero or multiple stops match, the update is discarded."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available matching fields:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"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":"code","inline":true,"attributes":{"content":"trip"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name.matches_any"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trip name(s)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name.matches_any"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order name(s)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer_reference_number.matches_any"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer reference number(s)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id.matches_any"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order UUID(s)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consignment"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference_number.matches_any"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Consignment reference number(s)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consignment"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order_sequence_number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Consignment sequence number within the order (integer)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference_number.matches_any"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stop reference number(s)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop_type"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PICKUP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELIVERY"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"matches_any"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field accepts a list of values — the stop matches if its value equals "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"any"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of them."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When multiple fields are provided, they are all required to match (AND)."},"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":"Example — match by order reference + stop type:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"updates\": [\n    {\n      \"stop\": {\n        \"match\": {\n          \"matches_all\": [\n            {\n              \"order\": { \"customer_reference_number\": { \"matches_any\": [\"REF-12345\"] } },\n              \"stop\": { \"stop_type\": \"DELIVERY\" }\n            }\n          ]\n        },\n        \"status\": \"COMPLETED\"\n      },\n      \"event_time\": \"2025-06-15T14:00:00Z\"\n    }\n  ]\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"updates\": [\n    {\n      \"stop\": {\n        \"match\": {\n          \"matches_all\": [\n            {\n              \"order\": { \"customer_reference_number\": { \"matches_any\": [\"REF-12345\"] } },\n              \"stop\": { \"stop_type\": \"DELIVERY\" }\n            }\n          ]\n        },\n        \"status\": \"COMPLETED\"\n      },\n      \"event_time\": \"2025-06-15T14:00:00Z\"\n    }\n  ]\n}\n"},"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":"Example — match by trip name + consignment reference:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"updates\": [\n    {\n      \"stop\": {\n        \"match\": {\n          \"matches_all\": [\n            {\n              \"trip\": { \"name\": { \"matches_any\": [\"T-20250615-001\"] } },\n              \"consignment\": { \"reference_number\": { \"matches_any\": [\"CONS-98765\"] } }\n            }\n          ]\n        },\n        \"status\": \"AT_STOP\",\n        \"eta_end\": \"2025-06-15T16:00:00Z\"\n      },\n      \"event_time\": \"2025-06-15T14:30:00Z\"\n    }\n  ]\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"updates\": [\n    {\n      \"stop\": {\n        \"match\": {\n          \"matches_all\": [\n            {\n              \"trip\": { \"name\": { \"matches_any\": [\"T-20250615-001\"] } },\n              \"consignment\": { \"reference_number\": { \"matches_any\": [\"CONS-98765\"] } }\n            }\n          ]\n        },\n        \"status\": \"AT_STOP\",\n        \"eta_end\": \"2025-06-15T16:00:00Z\"\n      },\n      \"event_time\": \"2025-06-15T14:30:00Z\"\n    }\n  ]\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/fleet-status-update-webhook/request/use-case-fleet-dispatch/fleet-status-update-webhook/request/stop-group-updates","deepLinkHash":"/webhooks-inbound/fleet-status-update-webhook#webhooks-inbound/fleet-status-update-webhook/request/use-case-fleet-dispatch/fleet-status-update-webhook/request/stop-group-updates"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stop group updates"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A stop group represents multiple stops grouped by activity and location. When updating via"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop_group"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the status applies to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all stops"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in that group. The stop group "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is always"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"required — matching by criteria is not supported for stop groups."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"updates\": [\n    {\n      \"stop_group\": {\n        \"id\": \"b2c3d4e5-0000-0000-0000-000000000000\",\n        \"status\": \"COMPLETED\"\n      },\n      \"event_time\": \"2025-06-15T16:00:00Z\"\n    }\n  ]\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"updates\": [\n    {\n      \"stop_group\": {\n        \"id\": \"b2c3d4e5-0000-0000-0000-000000000000\",\n        \"status\": \"COMPLETED\"\n      },\n      \"event_time\": \"2025-06-15T16:00:00Z\"\n    }\n  ]\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/fleet-status-update-webhook/request/use-case-fleet-dispatch/fleet-status-update-webhook/request/statuses","deepLinkHash":"/webhooks-inbound/fleet-status-update-webhook#webhooks-inbound/fleet-status-update-webhook/request/use-case-fleet-dispatch/fleet-status-update-webhook/request/statuses"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statuses"},"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":"code","inline":true,"attributes":{"content":"AT_STOP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the vehicle has arrived at the stop location."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the stop activity is finished."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Omit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to update only the ETA or data fields without changing the stop status."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuthWebhookCredentials","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FleetStatusUpdatePayload"}},"schemaId":"components/schemas/FleetStatusUpdatePayload","pointer":"/paths/~1v1~1webhook~1fleet-status-update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/webhook/fleet-status-update","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuthWebhookCredentials","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/FleetStatusUpdatePayload"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/webhook/fleet-status-update","href":"webhooks-inbound/fleet-status-update-webhook","openApiOperationId":"fleet-status-update-webhook","summary":"External Status Update From A Fleet Application"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/FleetStatusUpdatePayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FleetStatusUpdatePayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}},"schemaId":"schema_106"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1webhook~1fleet-status-update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_106","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks-inbound/fleet-status-update-webhook"}],"panels":[]}]},"httpPath":"/v1/webhook/fleet-status-update"},{"label":"Intermodal Booking Status Update Webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/webhooks-inbound/intermodal-booking-status-webhook","routeSlug":"/docs/webhooks-inbound/intermodal-booking-status-webhook","metadata":{"seo":{"title":"Intermodal Booking Status Update Webhook","description":"Inbound webhook to receive intermodal booking status updates from the external intermodal booking system."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"intermodal-booking-status-webhook","name":"Intermodal Booking Status Update Webhook","isWebhook":false,"pointer":"/paths/~1v1~1webhook~1intermodal-status/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Intermodal Booking Status Update Webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Inbound webhook to receive intermodal booking status updates from the external intermodal booking system."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuthWebhookCredentials","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_128"}},"schemaId":"schema_128","pointer":"/paths/~1v1~1webhook~1intermodal-status/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/webhook/intermodal-status","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuthWebhookCredentials","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_128"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/webhook/intermodal-status","href":"webhooks-inbound/intermodal-booking-status-webhook","openApiOperationId":"intermodal-booking-status-webhook","summary":"Intermodal Booking Status Update Webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"schema_128","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_128"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}},"schemaId":"schema_106"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1webhook~1intermodal-status/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_106","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks-inbound/intermodal-booking-status-webhook"}],"panels":[]}]},"httpPath":"/v1/webhook/intermodal-status"},{"label":"Location Booking Update Webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/webhooks-inbound/location-booking-update-webhook","routeSlug":"/docs/webhooks-inbound/location-booking-update-webhook","metadata":{"seo":{"title":"Location Booking Update Webhook","description":"Inbound webhook to receive location booking updates from external systems."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"location-booking-update-webhook","name":"Location Booking Update Webhook","isWebhook":false,"pointer":"/paths/~1v1~1webhook~1location-booking-update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Location Booking Update Webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Inbound webhook to receive location booking updates from external systems."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuthWebhookCredentials","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LocationBookingUpdatePayload"}},"schemaId":"components/schemas/LocationBookingUpdatePayload","pointer":"/paths/~1v1~1webhook~1location-booking-update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/webhook/location-booking-update","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuthWebhookCredentials","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LocationBookingUpdatePayload"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/webhook/location-booking-update","href":"webhooks-inbound/location-booking-update-webhook","openApiOperationId":"location-booking-update-webhook","summary":"Location Booking Update Webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/LocationBookingUpdatePayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LocationBookingUpdatePayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_130"}},"schemaId":"schema_130"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1webhook~1location-booking-update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_130","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_130"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks-inbound/location-booking-update-webhook"}],"panels":[]}]},"httpPath":"/v1/webhook/location-booking-update"},{"label":"Create/Update/Cancel Orders","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/webhooks-inbound/order-import-webhook","routeSlug":"/docs/webhooks-inbound/order-import-webhook","metadata":{"seo":{"title":"Create/Update/Cancel Orders","description":"Webhook for creating/updating and cancelling transport orders."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"order-import-webhook","name":"Create/Update/Cancel Orders","isWebhook":false,"pointer":"/paths/~1v1~1webhook/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create/Update/Cancel Orders","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":"Webhook for creating/updating and cancelling transport orders."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the fully asynchronous version of the order upload api."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The documented schema is our default input format, but we can also map custom formats."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that this webhook uses Basic Auth instead of the OAuth credentials used for the api."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please contact integrations@qargo.com to request credentials."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuthWebhookCredentials","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_150"}},"schemaId":"schema_150","pointer":"/paths/~1v1~1webhook/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/webhook","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuthWebhookCredentials","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_150"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/webhook","href":"webhooks-inbound/order-import-webhook","openApiOperationId":"order-import-webhook","summary":"Create/Update/Cancel Orders"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"schema_150","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_150"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_151"}},"schemaId":"schema_151"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1webhook/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_151","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_151"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks-inbound/order-import-webhook"}],"panels":[]}]},"httpPath":"/v1/webhook"},{"label":"Partial Order Update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/webhooks-inbound/partial-order-update","routeSlug":"/docs/webhooks-inbound/partial-order-update","metadata":{"seo":{"title":"Partial Order Update","description":"Webhook for partial order updates. Push to the endpoint to update specific fields of an existing order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"partial-order-update","name":"Partial Order Update","isWebhook":false,"pointer":"/paths/~1v1~1webhook~1partial-order-update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partial Order Update","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Webhook for partial order updates. Push to the endpoint to update specific fields of an existing order."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuthWebhookCredentials","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderUpdatePayload"}},"schemaId":"components/schemas/OrderUpdatePayload","pointer":"/paths/~1v1~1webhook~1partial-order-update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/webhook/partial-order-update","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuthWebhookCredentials","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrderUpdatePayload"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/webhook/partial-order-update","href":"webhooks-inbound/partial-order-update","openApiOperationId":"partial-order-update","summary":"Partial Order Update"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/OrderUpdatePayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderUpdatePayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_152"}},"schemaId":"schema_152"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1webhook~1partial-order-update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_152","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_152"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks-inbound/partial-order-update"}],"panels":[]}]},"httpPath":"/v1/webhook/partial-order-update"},{"label":"External Status Update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/webhooks-inbound/subcontractor-status-update-webhook","routeSlug":"/docs/webhooks-inbound/subcontractor-status-update-webhook","metadata":{"seo":{"title":"External Status Update","description":"Webhook for updating the status, ETA, and data of stops from an external subcontractor system."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"subcontractor-status-update-webhook","name":"External Status Update","isWebhook":false,"pointer":"/paths/~1v1~1webhook~1subco-status-update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"External Status Update","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":"Webhook for updating the status, ETA, and data of stops from an external subcontractor system."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that this webhook uses Basic Auth instead of the OAuth credentials used for the api."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please contact integrations@qargo.com to request credentials."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eta_start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eta_end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" date-time values must include a timezone offset,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2025-06-15T10:30:00Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2025-06-15T12:30:00+02:00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/subcontractor-status-update-webhook/request/use-case-subcontractor-dispatch/subcontractor-status-update-webhook/request/identifying-a-stop","deepLinkHash":"/webhooks-inbound/subcontractor-status-update-webhook#webhooks-inbound/subcontractor-status-update-webhook/request/use-case-subcontractor-dispatch/subcontractor-status-update-webhook/request/identifying-a-stop"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifying a stop"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each update targets a single stop. You can identify it by its Qargo UUID or by matching criteria."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"webhooks-inbound/subcontractor-status-update-webhook/request/use-case-subcontractor-dispatch/subcontractor-status-update-webhook/request/by-stop-id-(preferred)","deepLinkHash":"/webhooks-inbound/subcontractor-status-update-webhook#webhooks-inbound/subcontractor-status-update-webhook/request/use-case-subcontractor-dispatch/subcontractor-status-update-webhook/request/by-stop-id-(preferred)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By stop ID (preferred)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you know the Qargo stop UUID, pass it directly in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"updates\": [\n    {\n      \"stop\": { \"id\": \"a1b2c3d4-0000-0000-0000-000000000000\", \"status\": \"AT_STOP\" },\n      \"event_time\": \"2025-06-15T10:30:00Z\"\n    }\n  ]\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"updates\": [\n    {\n      \"stop\": { \"id\": \"a1b2c3d4-0000-0000-0000-000000000000\", \"status\": \"AT_STOP\" },\n      \"event_time\": \"2025-06-15T10:30:00Z\"\n    }\n  ]\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"webhooks-inbound/subcontractor-status-update-webhook/request/use-case-subcontractor-dispatch/subcontractor-status-update-webhook/request/by-matching-criteria","deepLinkHash":"/webhooks-inbound/subcontractor-status-update-webhook#webhooks-inbound/subcontractor-status-update-webhook/request/use-case-subcontractor-dispatch/subcontractor-status-update-webhook/request/by-matching-criteria"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By matching criteria"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the stop ID is not known, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop.match"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to find the stop by its related entities."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The matcher uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all provided criteria combined"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (AND logic) and expects "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"exactly one stop"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to match. If zero or multiple stops match, the update is discarded."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available matching fields:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"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":"code","inline":true,"attributes":{"content":"trip"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name.matches_any"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trip name(s)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name.matches_any"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order name(s)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer_reference_number.matches_any"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer reference number(s)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id.matches_any"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order UUID(s)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consignment"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference_number.matches_any"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Consignment reference number(s)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consignment"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order_sequence_number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Consignment sequence number within the order (integer)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference_number.matches_any"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stop reference number(s)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop_type"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PICKUP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELIVERY"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"matches_any"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field accepts a list of values — the stop matches if its value equals "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"any"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of them."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When multiple fields are provided, they are all required to match (AND)."},"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":"Example — match by order reference + stop type:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"updates\": [\n    {\n      \"stop\": {\n        \"match\": {\n          \"matches_all\": [\n            {\n              \"order\": { \"customer_reference_number\": { \"matches_any\": [\"REF-12345\"] } },\n              \"stop\": { \"stop_type\": \"DELIVERY\" }\n            }\n          ]\n        },\n        \"status\": \"COMPLETED\"\n      },\n      \"event_time\": \"2025-06-15T14:00:00Z\"\n    }\n  ]\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"updates\": [\n    {\n      \"stop\": {\n        \"match\": {\n          \"matches_all\": [\n            {\n              \"order\": { \"customer_reference_number\": { \"matches_any\": [\"REF-12345\"] } },\n              \"stop\": { \"stop_type\": \"DELIVERY\" }\n            }\n          ]\n        },\n        \"status\": \"COMPLETED\"\n      },\n      \"event_time\": \"2025-06-15T14:00:00Z\"\n    }\n  ]\n}\n"},"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":"Example — match by trip name + consignment reference:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"updates\": [\n    {\n      \"stop\": {\n        \"match\": {\n          \"matches_all\": [\n            {\n              \"trip\": { \"name\": { \"matches_any\": [\"T-20250615-001\"] } },\n              \"consignment\": { \"reference_number\": { \"matches_any\": [\"CONS-98765\"] } }\n            }\n          ]\n        },\n        \"status\": \"AT_STOP\",\n        \"eta_end\": \"2025-06-15T16:00:00Z\"\n      },\n      \"event_time\": \"2025-06-15T14:30:00Z\"\n    }\n  ]\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"updates\": [\n    {\n      \"stop\": {\n        \"match\": {\n          \"matches_all\": [\n            {\n              \"trip\": { \"name\": { \"matches_any\": [\"T-20250615-001\"] } },\n              \"consignment\": { \"reference_number\": { \"matches_any\": [\"CONS-98765\"] } }\n            }\n          ]\n        },\n        \"status\": \"AT_STOP\",\n        \"eta_end\": \"2025-06-15T16:00:00Z\"\n      },\n      \"event_time\": \"2025-06-15T14:30:00Z\"\n    }\n  ]\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks-inbound/subcontractor-status-update-webhook/request/use-case-subcontractor-dispatch/subcontractor-status-update-webhook/request/statuses","deepLinkHash":"/webhooks-inbound/subcontractor-status-update-webhook#webhooks-inbound/subcontractor-status-update-webhook/request/use-case-subcontractor-dispatch/subcontractor-status-update-webhook/request/statuses"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statuses"},"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":"code","inline":true,"attributes":{"content":"AT_STOP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the vehicle has arrived at the stop location."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the stop activity is finished."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Omit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to update only the ETA or data fields without changing the stop status."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuthWebhookCredentials","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubcontractorStatusUpdatePayload"}},"schemaId":"components/schemas/SubcontractorStatusUpdatePayload","pointer":"/paths/~1v1~1webhook~1subco-status-update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/webhook/subco-status-update","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuthWebhookCredentials","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SubcontractorStatusUpdatePayload"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/webhook/subco-status-update","href":"webhooks-inbound/subcontractor-status-update-webhook","openApiOperationId":"subcontractor-status-update-webhook","summary":"External Status Update"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/SubcontractorStatusUpdatePayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubcontractorStatusUpdatePayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}},"schemaId":"schema_106"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1webhook~1subco-status-update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_106","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks-inbound/subcontractor-status-update-webhook"}],"panels":[]}]},"httpPath":"/v1/webhook/subco-status-update"},{"label":"Tracking Update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/webhooks-inbound/tracking-update","routeSlug":"/docs/webhooks-inbound/tracking-update","metadata":{"seo":{"title":"Tracking Update","description":"Webhook for tracking updates."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tracking-update","name":"Tracking Update","isWebhook":false,"pointer":"/paths/~1v1~1webhook~1tracking-update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tracking Update","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Webhook for tracking updates.\n\nPush to the endpoint to update tracking information for a resource."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuthWebhookCredentials","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TrackingUpdatePayload"}},"schemaId":"components/schemas/TrackingUpdatePayload","pointer":"/paths/~1v1~1webhook~1tracking-update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/webhook/tracking-update","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuthWebhookCredentials","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TrackingUpdatePayload"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/webhook/tracking-update","href":"webhooks-inbound/tracking-update","openApiOperationId":"tracking-update","summary":"Tracking Update"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"components/schemas/TrackingUpdatePayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TrackingUpdatePayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_155"}},"schemaId":"schema_155"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1webhook~1tracking-update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_155","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_155"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks-inbound/tracking-update"}],"panels":[]}]},"httpPath":"/v1/webhook/tracking-update"},{"label":"Import Trip","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/webhooks-inbound/trip-import-webhook","routeSlug":"/docs/webhooks-inbound/trip-import-webhook","metadata":{"seo":{"title":"Import Trip","description":"Webhook for planning a list of stops on a trip and assigning resources."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"trip-import-webhook","name":"Import Trip","isWebhook":false,"pointer":"/paths/~1v1~1webhook~1trip-import/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Import Trip","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":"Webhook for planning a list of stops on a trip and assigning resources."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The documented schema is our default input format, but we can also map custom formats,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"keeping in mind the limitations that are documented under use cases."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that this webhook uses Basic Auth instead of the OAuth credentials used for the api."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please contact integrations@qargo.com to request credentials."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuthWebhookCredentials","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_156"}},"schemaId":"schema_156","pointer":"/paths/~1v1~1webhook~1trip-import/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/webhook/trip-import","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuthWebhookCredentials","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_156"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"/v1/webhook/trip-import","href":"webhooks-inbound/trip-import-webhook","openApiOperationId":"trip-import-webhook","summary":"Import Trip"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"schema_156","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_156"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_157"}},"schemaId":"schema_157"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1webhook~1trip-import/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_157","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_157"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks-inbound/trip-import-webhook"}],"panels":[]}]},"httpPath":"/v1/webhook/trip-import"}],"content":{"contentType":"group","meta":{"name":"Webhooks / Inbound"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Webhooks / Inbound","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":"Inbound webhooks use "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Basic Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", not OAuth2. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/section/authentication"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details on how to authenticate webhook requests."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/webhook/billing-document-update","summary":"External Billing Document (Invoice/Credit-Note) Update","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks-inbound/billing-document-update-webhook","deprecated":false},{"title":"/v1/webhook/document-import","summary":"Generic Document Import","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks-inbound/document-import-webhook","deprecated":false},{"title":"/v1/webhook/fleet-document-upload","summary":"External Document Upload From A Fleet Application","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks-inbound/fleet-document-upload-webhook","deprecated":false},{"title":"/v1/webhook/subco-document-upload","summary":"External Document Update With Payload","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks-inbound/subcontractor-document-upload-webhook","deprecated":false},{"title":"/v1/webhook/e-invoicing","summary":"Send E-Invoices","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks-inbound/e-invoicing-webhook","deprecated":false},{"title":"/v1/webhook/fleet-status-update","summary":"External Status Update From A Fleet Application","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks-inbound/fleet-status-update-webhook","deprecated":false},{"title":"/v1/webhook/intermodal-status","summary":"Intermodal Booking Status Update Webhook","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks-inbound/intermodal-booking-status-webhook","deprecated":false},{"title":"/v1/webhook/location-booking-update","summary":"Location Booking Update Webhook","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks-inbound/location-booking-update-webhook","deprecated":false},{"title":"/v1/webhook","summary":"Create/Update/Cancel Orders","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks-inbound/order-import-webhook","deprecated":false},{"title":"/v1/webhook/partial-order-update","summary":"Partial Order Update","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks-inbound/partial-order-update","deprecated":false},{"title":"/v1/webhook/subco-status-update","summary":"External Status Update","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks-inbound/subcontractor-status-update-webhook","deprecated":false},{"title":"/v1/webhook/tracking-update","summary":"Tracking Update","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks-inbound/tracking-update","deprecated":false},{"title":"/v1/webhook/trip-import","summary":"Import Trip","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks-inbound/trip-import-webhook","deprecated":false}]}]}]}]}},{"type":"group","label":"Webhooks / Outbound","link":"/docs/webhooks-outbound","routeSlug":"/docs/webhooks-outbound","items":[{"label":"Accounting Visibility Event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/webhooks-outbound/accounting_visibility_eventhttps____accounting_visibility_event_receiving_payload__post","routeSlug":"/docs/webhooks-outbound/accounting_visibility_eventhttps____accounting_visibility_event_receiving_payload__post","metadata":{"seo":{"title":"Accounting Visibility Event","description":"Webhook for updates to orders and trips. Subscribe to this endpoint to receive updates."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Accounting_visibility_eventhttps____accounting_visibility_event_receiving_payload__post","name":"Accounting Visibility Event","isWebhook":false,"pointer":"/paths/https:~1~1<accounting-visibility-event-receiving-payload>/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Accounting Visibility Event","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Webhook for updates to orders and trips. Subscribe to this endpoint to receive updates.\n\nNote that both support our canonical VisibilityUpdate schema,\nbut the body can also be a custom mapped format."},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_107"}},"schemaId":"schema_107","pointer":"/paths/https:~1~1<accounting-visibility-event-receiving-payload>/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"https://<accounting-visibility-event-receiving-payload>","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_107"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"https://<accounting-visibility-event-receiving-payload>","href":"webhooks-outbound/accounting_visibility_eventhttps____accounting_visibility_event_receiving_payload__post","openApiOperationId":"Accounting_visibility_eventhttps____accounting_visibility_event_receiving_payload__post","summary":"Accounting Visibility Event"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"schema_107","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_107"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}},"schemaId":"schema_106"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/https:~1~1<accounting-visibility-event-receiving-payload>/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_106","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks-outbound/accounting_visibility_eventhttps____accounting_visibility_event_receiving_payload__post"}],"panels":[]}]},"httpPath":"https://<accounting-visibility-event-receiving-payload>"},{"label":"Operational Visibility Event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/webhooks-outbound/operational_visibility_event_webhook_post","routeSlug":"/docs/webhooks-outbound/operational_visibility_event_webhook_post","metadata":{"seo":{"title":"Operational Visibility Event","description":"Webhook for updates to orders and trips. Subscribe to this endpoint to receive updates."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"operational_visibility_event_webhook_post","name":"Operational Visibility Event","isWebhook":false,"pointer":"/paths/https:~1~1<visibility-event-receiving-endpoint>/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Operational Visibility Event","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":"Webhook for updates to orders and trips. Subscribe to this endpoint to receive updates."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, Qargo sends payloads using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OperationalVisibilityUpdate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" schema:"},"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":"code","inline":true,"attributes":{"content":"order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OrderUpdate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"StopUpdate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DocumentUpdate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EtaUpdate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HandlingUnitUpdate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" events."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OrderImportUpdate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and other events not listed above may not include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is not populated"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"by default; including it requires a custom webhook format configured by Qargo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom webhook format configured by Qargo may use a different structure."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_117"}},"schemaId":"schema_117","pointer":"/paths/https:~1~1<visibility-event-receiving-endpoint>/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"https://<visibility-event-receiving-endpoint>","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_117"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"https://<visibility-event-receiving-endpoint>","href":"webhooks-outbound/operational_visibility_event_webhook_post","openApiOperationId":"operational_visibility_event_webhook_post","summary":"Operational Visibility Event"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"schema_117","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_117"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}},"schemaId":"schema_106"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/https:~1~1<visibility-event-receiving-endpoint>/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_106","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks-outbound/operational_visibility_event_webhook_post"}],"panels":[]}]},"httpPath":"https://<visibility-event-receiving-endpoint>"},{"label":"Fleet Dispatch Payload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/webhooks-outbound/fleet-dispatch-payload","routeSlug":"/docs/webhooks-outbound/fleet-dispatch-payload","metadata":{"seo":{"title":"Fleet Dispatch Payload","description":"Payload for sending fleet app dispatches.In this case, we send the payload to an external endpoint for processing."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"fleet-dispatch-payload","name":"Fleet Dispatch Payload","isWebhook":false,"pointer":"/paths/https:~1~1<external-fleet-receiving-endpoint>/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fleet Dispatch Payload","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":"Payload for sending fleet app dispatches."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In this case, we send the payload to an external endpoint for processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, we send our standard "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FleetDispatch"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" schema,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"but the body can also be a custom mapped format."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_126"}},"schemaId":"schema_126","pointer":"/paths/https:~1~1<external-fleet-receiving-endpoint>/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"https://<external-fleet-receiving-endpoint>","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_126"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"https://<external-fleet-receiving-endpoint>","href":"webhooks-outbound/fleet-dispatch-payload","openApiOperationId":"fleet-dispatch-payload","summary":"Fleet Dispatch Payload"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"schema_126","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_126"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_127"}},"schemaId":"schema_127"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/https:~1~1<external-fleet-receiving-endpoint>/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_127","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_127"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks-outbound/fleet-dispatch-payload"}],"panels":[]}]},"httpPath":"https://<external-fleet-receiving-endpoint>"},{"label":"Intermodal Booking Payload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/webhooks-outbound/intermodal_booking_payloadhttps____intermodal_booking_receiving_payload__post","routeSlug":"/docs/webhooks-outbound/intermodal_booking_payloadhttps____intermodal_booking_receiving_payload__post","metadata":{"seo":{"title":"Intermodal Booking Payload","description":"Outbound webhook to send intermodal bookings to the external intermodal booking system."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Intermodal_booking_payloadhttps____intermodal_booking_receiving_payload__post","name":"Intermodal Booking Payload","isWebhook":false,"pointer":"/paths/https:~1~1<intermodal-booking-receiving-payload>/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Intermodal Booking Payload","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Outbound webhook to send intermodal bookings to the external intermodal booking system."},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_129"}},"schemaId":"schema_129","pointer":"/paths/https:~1~1<intermodal-booking-receiving-payload>/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"https://<intermodal-booking-receiving-payload>","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_129"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"https://<intermodal-booking-receiving-payload>","href":"webhooks-outbound/intermodal_booking_payloadhttps____intermodal_booking_receiving_payload__post","openApiOperationId":"Intermodal_booking_payloadhttps____intermodal_booking_receiving_payload__post","summary":"Intermodal Booking Payload"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"schema_129","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_129"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}},"schemaId":"schema_106"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/https:~1~1<intermodal-booking-receiving-payload>/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_106","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks-outbound/intermodal_booking_payloadhttps____intermodal_booking_receiving_payload__post"}],"panels":[]}]},"httpPath":"https://<intermodal-booking-receiving-payload>"},{"label":"Location Booking Dispatch Payload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/webhooks-outbound/location-dispatch-payload","routeSlug":"/docs/webhooks-outbound/location-dispatch-payload","metadata":{"seo":{"title":"Location Booking Dispatch Payload","description":"Payload for sending location booking dispatches."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"location-dispatch-payload","name":"Location Booking Dispatch Payload","isWebhook":false,"pointer":"/paths/https:~1~1<location-booking-receiving-endpoint>/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Location Booking Dispatch Payload","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":"Payload for sending location booking dispatches."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, we send our standard "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LocationDispatchOutput"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" schema,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"but the body can also be a custom mapped format."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_131"}},"schemaId":"schema_131","pointer":"/paths/https:~1~1<location-booking-receiving-endpoint>/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"https://<location-booking-receiving-endpoint>","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_131"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"https://<location-booking-receiving-endpoint>","href":"webhooks-outbound/location-dispatch-payload","openApiOperationId":"location-dispatch-payload","summary":"Location Booking Dispatch Payload"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"schema_131","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_131"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_132"}},"schemaId":"schema_132"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/https:~1~1<location-booking-receiving-endpoint>/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_132","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_132"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks-outbound/location-dispatch-payload"}],"panels":[]}]},"httpPath":"https://<location-booking-receiving-endpoint>"},{"label":"Subcontractor Dispatch Payload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/webhooks-outbound/subcontractor-dispatch-payload","routeSlug":"/docs/webhooks-outbound/subcontractor-dispatch-payload","metadata":{"seo":{"title":"Subcontractor Dispatch Payload","description":"Payload for sending a trip dispatch.In this case, we send the payload to an external endpoint for processing."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"subcontractor-dispatch-payload","name":"Subcontractor Dispatch Payload","isWebhook":false,"pointer":"/paths/https:~1~1<external_subco_receiving_endpoint>/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subcontractor Dispatch Payload","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":"Payload for sending a trip dispatch."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In this case, we send the payload to an external endpoint for processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, we send our standard "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SubcontractorDispatch"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" schema,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"but the body can also be a custom mapped format."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_153"}},"schemaId":"schema_153","pointer":"/paths/https:~1~1<external_subco_receiving_endpoint>/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"https://<external_subco_receiving_endpoint>","servers":[{"url":"https://api.qargo.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_153"}},"responseCodes":["200","400","401","403","422","429","500","503"],"pointer":"https://<external_subco_receiving_endpoint>","href":"webhooks-outbound/subcontractor-dispatch-payload","openApiOperationId":"subcontractor-dispatch-payload","summary":"Subcontractor Dispatch Payload"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.qargo.com"}],"schemaId":"schema_153","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_153"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_154"}},"schemaId":"schema_154"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invalid input or malformed request"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized — missing or invalid authentication credentials"},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — insufficient permissions for this operation"},"children":[]}]}]}]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests — rate limit exceeded. See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Unavailable — temporarily unable to handle the request"},"children":[]}]}]}]}],"pointer":"/paths/https:~1~1<external_subco_receiving_endpoint>/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_154","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_154"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}},{"code":"401"},{"code":"403"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks-outbound/subcontractor-dispatch-payload"}],"panels":[]}]},"httpPath":"https://<external_subco_receiving_endpoint>"}],"content":{"contentType":"group","meta":{"name":"Webhooks / Outbound"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Webhooks / Outbound","showPageActions":true},{"nodeType":"markdoc","content":"Outbound webhooks are sent by Qargo to your system when certain events occur. Configure the receiving endpoint URL and credentials in the integration settings."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"https://<accounting-visibility-event-receiving-payload>","summary":"Accounting Visibility Event","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks-outbound/accounting_visibility_eventhttps____accounting_visibility_event_receiving_payload__post","deprecated":false},{"title":"https://<visibility-event-receiving-endpoint>","summary":"Operational Visibility Event","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks-outbound/operational_visibility_event_webhook_post","deprecated":false},{"title":"https://<external-fleet-receiving-endpoint>","summary":"Fleet Dispatch Payload","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks-outbound/fleet-dispatch-payload","deprecated":false},{"title":"https://<intermodal-booking-receiving-payload>","summary":"Intermodal Booking Payload","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks-outbound/intermodal_booking_payloadhttps____intermodal_booking_receiving_payload__post","deprecated":false},{"title":"https://<location-booking-receiving-endpoint>","summary":"Location Booking Dispatch Payload","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks-outbound/location-dispatch-payload","deprecated":false},{"title":"https://<external_subco_receiving_endpoint>","summary":"Subcontractor Dispatch Payload","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks-outbound/subcontractor-dispatch-payload","deprecated":false}]}]}]}]}},{"type":"separator","label":"","content":null}],"store":{"schemaStore":{"components/schemas/ADR-Input":{"id":"components/schemas/ADR-Input","kind":"json-schema","title":"ADR","data":{"properties":{"adr_name_by_locale":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Adr Name By Locale","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ADR name by locale, generated from ADR master data. This field is read-only; values submitted during order import are ignored. Keys, when present, are one of: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en-GB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en-US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nl-BE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fi-FI"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fr-FR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"de-DE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"it-IT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"es-ES"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hu-HU"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pt-PT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tr-TR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pl-PL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ro-RO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ru-RU"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bg-BG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lt-LT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mk-MK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cs-CZ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Values are the corresponding localized ADR names."},"children":[]}]}]}],"examples":[{"de-DE":"SALZSÄURE","en":"HYDROCHLORIC ACID"}]},"un_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Un Number","description":"See https://adr-tool.com/lists-of-un-numbers"},"packaging_type":{"anyOf":[{"$ref":"#/components/schemas/ADRPackagingType"},{"type":"null"}],"description":"Packaging type"},"emergency_phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Emergency Phone Number","description":"Emergency phone number"},"technical_name_by_locale":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Technical Name By Locale","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Technical name by locale. Keys are locale codes and values are the corresponding localized technical names. Supported locale codes: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en-GB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en-US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nl-BE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fi-FI"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fr-FR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"de-DE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"it-IT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"es-ES"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hu-HU"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pt-PT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tr-TR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pl-PL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ro-RO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ru-RU"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bg-BG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lt-LT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mk-MK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cs-CZ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":[{"de-DE":"NEG Stoffname","en":"NEG Substance name","fr-FR":"NEG Nom de la substance","nl-BE":"NEG Stofnaam"}]},"classification_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Classification Code","description":"ADR classification code"},"transport_category_tunnel_restriction_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transport Category Tunnel Restriction Code","description":"A letter code (A-E) that reflects restrictions for carrying the substance through road tunnels - Helps improve ADR matching beyond just using UN number"},"packing_group":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Packing Group","description":"Indicates danger level - Helps improve ADR matching beyond just using UN number"},"adr_class":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Adr Class","description":"Identifies the primary hazard category of the substance - Helps improve ADR matching beyond just using UN number"},"physical_state":{"anyOf":[{"$ref":"#/components/schemas/ADRPhysicalState"},{"type":"null"}],"description":"Describes the form of the substance. Indicates whether the substance is a solid, liquid or gas"},"hazard_identification_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hazard Identification Number","description":"Also known as Kemler code. Used in ADR labeling"},"division":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Division","description":"ADR division/subclass (e.g. '1.2', '2.1'). Populated for classes 1, 2, 4, 5 and 6"},"labels":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Labels","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subsidiary hazard class labels (ADR), '+'-separated when multiple. Example: '6.1+5.1'."},"children":[]}]}]}]},"special_provisions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Special Provisions","description":"ADR special provisions code(s) applying to this substance. Example: '274 640D'."}},"type":"object","title":"ADR"}},"components/schemas/ADR-Output":{"id":"components/schemas/ADR-Output","kind":"json-schema","title":"ADR","data":{"properties":{"adr_name_by_locale":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Adr Name By Locale","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ADR name by locale, generated from ADR master data. This field is read-only; values submitted during order import are ignored. Keys, when present, are one of: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en-GB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en-US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nl-BE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fi-FI"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fr-FR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"de-DE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"it-IT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"es-ES"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hu-HU"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pt-PT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tr-TR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pl-PL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ro-RO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ru-RU"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bg-BG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lt-LT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mk-MK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cs-CZ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Values are the corresponding localized ADR names."},"children":[]}]}]}],"examples":[{"de-DE":"SALZSÄURE","en":"HYDROCHLORIC ACID"}]},"un_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Un Number","description":"See https://adr-tool.com/lists-of-un-numbers"},"packaging_type":{"anyOf":[{"$ref":"#/components/schemas/ADRPackagingType"},{"type":"null"}],"description":"Packaging type"},"emergency_phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Emergency Phone Number","description":"Emergency phone number"},"technical_name_by_locale":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Technical Name By Locale","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Technical name by locale. Keys are locale codes and values are the corresponding localized technical names. Supported locale codes: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en-GB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en-US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nl-BE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fi-FI"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fr-FR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"de-DE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"it-IT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"es-ES"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hu-HU"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pt-PT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tr-TR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pl-PL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ro-RO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ru-RU"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bg-BG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lt-LT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mk-MK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cs-CZ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":[{"de-DE":"NEG Stoffname","en":"NEG Substance name","fr-FR":"NEG Nom de la substance","nl-BE":"NEG Stofnaam"}]},"classification_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Classification Code","description":"ADR classification code"},"tunnel_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tunnel Code","description":"A letter code (A-E) that reflects restrictions for carrying the substance through road tunnels - Helps improve ADR matching beyond just using UN number"},"packing_group":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Packing Group","description":"Indicates danger level - Helps improve ADR matching beyond just using UN number"},"adr_class":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Adr Class","description":"Identifies the primary hazard category of the substance - Helps improve ADR matching beyond just using UN number"},"physical_state":{"anyOf":[{"$ref":"#/components/schemas/ADRPhysicalState"},{"type":"null"}],"description":"Describes the form of the substance. Indicates whether the substance is a solid, liquid or gas"},"hazard_identification_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hazard Identification Number","description":"Also known as Kemler code. Used in ADR labeling"},"division":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Division","description":"ADR division/subclass (e.g. '1.2', '2.1'). Populated for classes 1, 2, 4, 5 and 6"},"labels":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Labels","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subsidiary hazard class labels (ADR), '+'-separated when multiple. Example: '6.1+5.1'."},"children":[]}]}]}]},"special_provisions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Special Provisions","description":"ADR special provisions code(s) applying to this substance. Example: '274 640D'."}},"type":"object","title":"ADR"}},"components/schemas/ADRInput":{"id":"components/schemas/ADRInput","kind":"json-schema","title":"ADRInput","data":{"properties":{"un_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Un Number"},"packaging_type":{"anyOf":[{"type":"string","enum":["BOX","COMPOSITE_PACKAGING","DRUM","GAS_RECEPTABLE","INTERMEDIATE_BULK_CONTAINER","JERRICAN","LARGE_PACKAGING","LIGHT_GAUGE_METAL_PACKAGINGS","BAG","TANK_CONTAINER"]},{"type":"null"}],"title":"Packaging Type"},"emergency_phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Emergency Phone Number"},"technical_name_by_locale":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Technical Name By Locale"},"packing_group":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Packing Group"},"adr_class":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Adr Class"},"tunnel_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tunnel Code"},"physical_state":{"anyOf":[{"type":"string","enum":["UNKNOWN","SOLID","LIQUID","GAS","GAS_OR_LIQUID"]},{"type":"null"}],"title":"Physical State"}},"type":"object","title":"ADRInput"}},"components/schemas/ADRPackagingType":{"id":"components/schemas/ADRPackagingType","kind":"json-schema","title":"ADRPackagingType","data":{"type":"string","enum":["BOX","COMPOSITE_PACKAGING","DRUM","GAS_RECEPTABLE","INTERMEDIATE_BULK_CONTAINER","JERRICAN","LARGE_PACKAGING","LIGHT_GAUGE_METAL_PACKAGINGS","BAG","TANK_CONTAINER"],"title":"ADRPackagingType"}},"components/schemas/ADRPhysicalState":{"id":"components/schemas/ADRPhysicalState","kind":"json-schema","title":"ADRPhysicalState","data":{"type":"string","enum":["UNKNOWN","SOLID","LIQUID","GAS","GAS_OR_LIQUID"],"title":"ADRPhysicalState"}},"components/schemas/ADRType":{"id":"components/schemas/ADRType","kind":"json-schema","title":"ADRType","data":{"type":"string","enum":["ADR","LIMITED_QUANTITY"],"title":"ADRType"}},"components/schemas/AccountPartialInput":{"id":"components/schemas/AccountPartialInput","kind":"json-schema","title":"AccountPartialInput","data":{"properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Accounting code (GL / nominal code)."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Display name of the account."},"billing_entity":{"anyOf":[{"$ref":"#/components/schemas/BillingEntityReference"},{"type":"null"}],"description":"Billing entity this account belongs to, referenced by code."},"archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Archived","description":"Whether this account is archived."}},"type":"object","title":"AccountPartialInput"}},"components/schemas/AccountingVisibilityUpdate":{"id":"components/schemas/AccountingVisibilityUpdate","kind":"json-schema","title":"AccountingVisibilityUpdate","data":{"properties":{"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"Event timestamp in UTC"},"updates":{"items":{"anyOf":[{"$ref":"#/components/schemas/SalesInvoiceStatusUpdate"},{"$ref":"#/components/schemas/SalesCreditNoteStatusUpdate"},{"$ref":"#/components/schemas/PurchaseInvoiceStatusUpdate"},{"$ref":"#/components/schemas/PurchaseCreditNoteStatusUpdate"}]},"type":"array","title":"Updates","description":"Set of updates for invoices and credit notes. Note that by default these events will only trigger on status transitions, not on field changes. Note that this is a combination of invoicing and accounting updates."}},"type":"object","required":["timestamp","updates"],"title":"AccountingVisibilityUpdate"}},"components/schemas/AdditionalExportBorderProcessEnum":{"id":"components/schemas/AdditionalExportBorderProcessEnum","kind":"json-schema","title":"AdditionalExportBorderProcessEnum","data":{"type":"string","enum":["GVMS","ELO","PBN","EIDR"],"title":"AdditionalExportBorderProcessEnum"}},"components/schemas/AdditionalGoodsInformation":{"id":"components/schemas/AdditionalGoodsInformation","kind":"json-schema","title":"AdditionalGoodsInformation","data":{"properties":{"is_dangerous_goods":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Dangerous Goods","description":"Whether the goods are classified as dangerous goods."},"goods_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Goods Description","description":"Description of the goods."},"goods_movement_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Goods Movement Reference","description":"Goods Movement Reference (GMR)."}},"type":"object","title":"AdditionalGoodsInformation"}},"components/schemas/AdditionalImportBorderProcessEnum":{"id":"components/schemas/AdditionalImportBorderProcessEnum","kind":"json-schema","title":"AdditionalImportBorderProcessEnum","data":{"type":"string","enum":["GVMS","ELO","PBN","TEMPORARY_STORAGE","EIDR"],"title":"AdditionalImportBorderProcessEnum"}},"components/schemas/AdditionalTransitBorderProcessEnum":{"id":"components/schemas/AdditionalTransitBorderProcessEnum","kind":"json-schema","title":"AdditionalTransitBorderProcessEnum","data":{"type":"string","enum":["LRN"],"title":"AdditionalTransitBorderProcessEnum"}},"components/schemas/AmazonExtraFields":{"id":"components/schemas/AmazonExtraFields","kind":"json-schema","title":"AmazonExtraFields","data":{"properties":{"asn_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Asn Number","description":"Amazon Shipment ID"},"fba_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fba Number","description":"Amazon FBA ID"},"po_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Po Number","description":"Amazon PO ID"},"amazon_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Amazon Number","description":"Amazon order number"},"carton_count":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Carton Count","description":"Number of cartons"},"unit_count":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit Count","description":"Number of units"},"booking_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Booking Date","description":"Amazon booking date"},"booking_time":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Booking Time","description":"Amazon booking time"}},"type":"object","title":"AmazonExtraFields"}},"components/schemas/AvailableTask":{"id":"components/schemas/AvailableTask","kind":"json-schema","title":"AvailableTask","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"invoice_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Invoice Id"},"task_type":{"$ref":"#/components/schemas/TaskType"},"status":{"$ref":"#/components/schemas/TaskStatus"}},"type":"object","required":["id","task_type","status"],"title":"AvailableTask","description":"Reference to a task available for processing."}},"components/schemas/AvailableTasks":{"id":"components/schemas/AvailableTasks","kind":"json-schema","title":"AvailableTasks","data":{"properties":{"tasks":{"items":{"$ref":"#/components/schemas/AvailableTask"},"type":"array","title":"Tasks"}},"type":"object","required":["tasks"],"title":"AvailableTasks"}},"components/schemas/BankAccount":{"id":"components/schemas/BankAccount","kind":"json-schema","title":"BankAccount","data":{"properties":{"bic_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bic Code"},"iban_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Iban Code"}},"type":"object","title":"BankAccount"}},"components/schemas/BarcodeInput":{"id":"components/schemas/BarcodeInput","kind":"json-schema","title":"BarcodeInput","data":{"properties":{"value":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Value","description":"Barcode value"},"source":{"anyOf":[{"$ref":"#/components/schemas/BarcodeSource"},{"type":"null"}],"description":"Source system of the barcode"}},"type":"object","title":"BarcodeInput"}},"components/schemas/BarcodeOutput":{"id":"components/schemas/BarcodeOutput","kind":"json-schema","title":"BarcodeOutput","data":{"properties":{"value":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Value","description":"Barcode value"},"source":{"anyOf":[{"$ref":"#/components/schemas/BarcodeSource"},{"type":"null"}],"description":"Source system of the barcode"}},"type":"object","title":"BarcodeOutput"}},"components/schemas/BarcodeSource":{"id":"components/schemas/BarcodeSource","kind":"json-schema","title":"BarcodeSource","data":{"type":"string","enum":["APC","EXTERNAL","QARGO","HAZCHEM","PALLETFORCE","PALLETLINE","PALLETLINE_OPTIMA","PALLETWAYS","PALLETXPRESS_IE","PALLET_TRACK","PALLEX","POLE","TPN","UPN"],"title":"BarcodeSource"}},"components/schemas/BasePaymentTerm":{"id":"components/schemas/BasePaymentTerm","kind":"json-schema","title":"BasePaymentTerm","data":{"properties":{"code":{"$ref":"#/components/schemas/PaymentTermCode","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment term codes and their explanations:"},"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":"code","inline":true,"attributes":{"content":"END_OF_MONTH_2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": End of next two months"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"END_OF_MONTH_1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": End of next month"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"END_OF_MONTH_0_NET_90"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": End of this month, plus 90 days"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"END_OF_MONTH_0_NET_75"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": End of this month, plus 75 days"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"END_OF_MONTH_0_NET_70"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": End of this month, plus 70 days"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"END_OF_MONTH_0_NET_65"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": End of this month, plus 65 days"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"END_OF_MONTH_0_NET_60"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": End of this month, plus 60 days"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"END_OF_MONTH_0_NET_50"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": End of this month, plus 50 days"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"END_OF_MONTH_0_NET_45"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": End of this month, plus 45 days"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"END_OF_MONTH_0_NET_35"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": End of this month, plus 35 days"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"END_OF_MONTH_0_NET_31"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": End of this month, plus 31 days"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"END_OF_MONTH_0_NET_30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": End of this month, plus 30 days"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"END_OF_MONTH_0_NET_25"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": End of this month, plus 25 days"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"END_OF_MONTH_0_NET_21"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": End of this month, plus 21 days"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"END_OF_MONTH_0_NET_20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": End of this month, plus 20 days"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"END_OF_MONTH_0_NET_14"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": End of this month, plus 14 days"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"END_OF_MONTH_0_NET_7"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": End of this month, plus 7 days"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"END_OF_MONTH_0_NET_1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": End of this month, plus 1 day"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"END_OF_MONTH_0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": End of month"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PREPAID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Prepaid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CUSTOM_DUE_DATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Custom due date, set on invoice creation. Not allowed to set via the API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UPON_RECEIPT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Upon receipt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NET_1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 1 day after receipt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NET_2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 2 days after receipt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NET_3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 3 days after receipt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NET_5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 5 days after receipt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NET_7"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 7 days after receipt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NET_8"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 8 days after receipt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NET_10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 10 days after receipt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NET_12"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 12 days after receipt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NET_14"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 14 days after receipt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NET_15"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 15 days after receipt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NET_20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 20 days after receipt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NET_21"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 21 days after receipt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NET_28"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 28 days after receipt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NET_30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 30 days after receipt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NET_35"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 35 days after receipt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NET_40"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 40 days after receipt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NET_42"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 42 days after receipt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NET_45"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 45 days after receipt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NET_48"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 48 days after receipt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NET_49"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 49 days after receipt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NET_50"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 50 days after receipt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NET_52"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 52 days after receipt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NET_55"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 55 days after receipt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NET_56"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 56 days after receipt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NET_60"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 60 days after receipt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NET_63"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 63 days after receipt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NET_70"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 70 days after receipt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NET_75"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 75 days after receipt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NET_77"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 77 days after receipt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NET_80"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 80 days after receipt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NET_84"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 84 days after receipt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NET_90"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 90 days after receipt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NET_91"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 91 days after receipt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NET_98"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 98 days after receipt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NET_120"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 120 days after receipt"},"children":[]}]}]}]}],"examples":["END_OF_MONTH_2"]}},"type":"object","required":["code"],"title":"BasePaymentTerm"}},"components/schemas/BaseStatusUpdate":{"id":"components/schemas/BaseStatusUpdate","kind":"json-schema","title":"BaseStatusUpdate","data":{"properties":{"stop":{"$ref":"#/components/schemas/StopStatusUpdate","description":"Update a stop. Can update status and data of a stop.\n        Updates on the data are based on a mapping defined in Qargo"},"event_time":{"type":"string","format":"date-time","title":"Event Time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time of the event in UTC. Include a timezone offset, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+02:00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"type":"object","required":["stop","event_time"],"title":"BaseStatusUpdate"}},"components/schemas/BaseTaxRate":{"id":"components/schemas/BaseTaxRate","kind":"json-schema","title":"BaseTaxRate","data":{"properties":{"percentage":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Percentage","examples":[21]}},"type":"object","title":"BaseTaxRate","description":"Original base tax rate, before applying customer/transport specific tax rules."}},"components/schemas/BillingDocumentMatchInput":{"id":"components/schemas/BillingDocumentMatchInput","kind":"json-schema","title":"BillingDocumentMatchInput","data":{"properties":{"sales_invoice":{"$ref":"#/components/schemas/SalesInvoiceMatch"}},"type":"object","required":["sales_invoice"],"title":"BillingDocumentMatchInput"}},"components/schemas/BillingDocumentMatchTarget":{"id":"components/schemas/BillingDocumentMatchTarget","kind":"json-schema","title":"BillingDocumentMatchTarget","data":{"properties":{"matches_all":{"items":{"$ref":"#/components/schemas/BillingDocumentMatchInput"},"type":"array","title":"Matches All"}},"type":"object","title":"BillingDocumentMatchTarget"}},"components/schemas/BillingDocumentUpdate":{"id":"components/schemas/BillingDocumentUpdate","kind":"json-schema","title":"BillingDocumentUpdate","data":{"properties":{"sales_invoice":{"anyOf":[{"$ref":"#/components/schemas/SalesInvoiceUpdate"},{"type":"null"}]}},"type":"object","title":"BillingDocumentUpdate"}},"components/schemas/BillingDocumentUpdatePayload":{"id":"components/schemas/BillingDocumentUpdatePayload","kind":"json-schema","title":"BillingDocumentUpdatePayload","data":{"properties":{"updates":{"items":{"$ref":"#/components/schemas/BillingDocumentUpdate"},"type":"array","title":"Updates","description":"List of updates to process"}},"type":"object","title":"BillingDocumentUpdatePayload"}},"components/schemas/BillingEntity":{"id":"components/schemas/BillingEntity","kind":"json-schema","title":"BillingEntity","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier of the billing entity in Qargo."},"legal_name":{"type":"string","title":"Legal Name","description":"Legal name of the billing entity.","examples":["Qargo BV"]},"vat_number":{"type":"string","title":"Vat Number","description":"VAT number of the billing entity.","examples":["NL123456789B01"]},"code":{"type":"string","title":"Code","description":"Code of the billing entity.","examples":["QARGO"]},"company_registration_number":{"type":"string","title":"Company Registration Number","description":"Company registration number of the billing entity.","examples":["12345678"]},"is_default":{"type":"boolean","title":"Is Default","description":"Indicates whether this billing entity is the default one.","default":false}},"type":"object","required":["id","legal_name","vat_number","code","company_registration_number"],"title":"BillingEntity"}},"components/schemas/BillingEntityReference":{"id":"components/schemas/BillingEntityReference","kind":"json-schema","title":"BillingEntityReference","data":{"properties":{"code":{"type":"string","title":"Code","description":"Code of the reference"}},"type":"object","required":["code"],"title":"BillingEntityReference"}},"components/schemas/BillingLocation":{"id":"components/schemas/BillingLocation","kind":"json-schema","title":"BillingLocation","data":{"properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code of the location","examples":[""]},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name","description":"Human-readable label for a location in operational views.","examples":["Main Office"]},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":"Identifier from an external (master data) system."},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address","description":"First address line of the location","examples":["Gaston Crommenlaan 4"]},"address_second_line":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address Second Line","description":"Second address line of the location","examples":[""]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City of the location","examples":["Ghent"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State of the location","examples":[""]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code (ISO 3166-1 alpha-2) of the location","examples":["BE"]},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Postal Code","description":"Postal code of the location","examples":["9050"]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the location","examples":["Qargo HQ"]}},"type":"object","title":"BillingLocation"}},"components/schemas/Body_Upload_document_content_v1_documents_document_upload_content_post":{"id":"components/schemas/Body_Upload_document_content_v1_documents_document_upload_content_post","kind":"json-schema","title":"Body_Upload_document_content_v1_documents_document_upload_content_post","data":{"properties":{"file":{"type":"string","format":"binary","title":"File"}},"type":"object","required":["file"],"title":"Body_Upload_document_content_v1_documents_document_upload_content_post"}},"components/schemas/Booking":{"id":"components/schemas/Booking","kind":"json-schema","title":"Booking","data":{"properties":{"booking_id":{"type":"string","format":"uuid","title":"Booking Id","description":"Unique technical Qargo id for the booking."},"booking_name":{"type":"string","title":"Booking Name","description":"Human-readable name of the booking in Qargo."},"booking_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Booking Reference","description":"Unique human-readable reference for the booking."},"shipping_company":{"$ref":"#/components/schemas/ShippingCompany"},"shipping_route":{"$ref":"#/components/schemas/ShippingRoute"},"transport_type":{"$ref":"#/components/schemas/TransportType"},"trailer":{"anyOf":[{"$ref":"#/components/schemas/Trailer"},{"type":"null"}]},"container":{"anyOf":[{"$ref":"#/components/schemas/Container"},{"type":"null"}]},"vehicle":{"anyOf":[{"$ref":"#/components/schemas/Vehicle"},{"type":"null"}]},"plugging":{"anyOf":[{"$ref":"#/components/schemas/Plugging"},{"type":"null"}]},"dimensions":{"$ref":"#/components/schemas/BookingDimensions"},"customs":{"anyOf":[{"$ref":"#/components/schemas/Customs"},{"type":"null"}]},"temperature_requirements":{"anyOf":[{"$ref":"#/components/schemas/TemperatureRequirements"},{"type":"null"}],"description":"Temperature settings for the booking."},"additional_goods_information":{"anyOf":[{"$ref":"#/components/schemas/AdditionalGoodsInformation"},{"type":"null"}],"description":"Additional information about the goods."},"seal_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Seal Number","description":"Container seal number."},"vessel_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vessel Name","description":"Name of the vessel."},"voyage_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Voyage Code","description":"Voyage code."},"imo_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Imo Number","description":"IMO number (formerly Lloyd's number)."},"references":{"anyOf":[{"$ref":"#/components/schemas/IntermodalBookingReferences"},{"type":"null"}],"description":"Booking references for the conveyances at the port of loading (POL) and port of discharge (POD)."},"execution_data":{"$ref":"#/components/schemas/BookingExecutionData","description":"Carrier-side execution data for the booking, such as movement statuses."}},"type":"object","required":["booking_id","booking_name","shipping_company","shipping_route","transport_type","dimensions"],"title":"Booking"}},"components/schemas/BookingDimensions":{"id":"components/schemas/BookingDimensions","kind":"json-schema","title":"BookingDimensions","data":{"properties":{"resource_type":{"anyOf":[{"$ref":"#/components/schemas/BookingVehicleType"},{"type":"null"}],"description":"Type of resource used in the booking."},"length":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Length","description":"Total vehicle length (combined tractor and trailer if both are present)."},"width":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Width","description":"Maximum vehicle width (combined tractor and trailer if both are present)."},"height":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Height","description":"Maximum vehicle height (combined tractor and trailer if both are present)."},"tare_weight":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Tare Weight","description":"Tare weight of the vehicle or container in kg."},"cargo_weight":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Cargo Weight","description":"Total cargo weight in kg (sum of the goods weights on the orders in this booking)."},"verified_gross_mass":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Verified Gross Mass","description":"Verified Gross Mass (VGM) in kg, equal to tare weight plus cargo weight. SOLAS compliant."},"is_loaded":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Loaded","description":"Whether the vehicle is loaded."},"weight":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Weight","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total weight (VGM) in kg. Replaced by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"verified_gross_mass"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", please use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"verified_gross_mass"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}],"deprecated":true}},"type":"object","title":"BookingDimensions"}},"components/schemas/BookingExecutionData":{"id":"components/schemas/BookingExecutionData","kind":"json-schema","title":"BookingExecutionData","data":{"properties":{"execution_statuses":{"items":{"$ref":"#/components/schemas/IntermodalExecutionStatus"},"type":"array","title":"Execution Statuses","description":"Operational movement statuses reported by the carrier, in chronological order."},"skip_dispatch":{"type":"boolean","title":"Skip Dispatch","description":"Whether the booking has been finalized and no longer accepts dispatch modifications.","default":false}},"type":"object","title":"BookingExecutionData"}},"components/schemas/BookingExecutionStatus":{"id":"components/schemas/BookingExecutionStatus","kind":"json-schema","title":"BookingExecutionStatus","data":{"properties":{"event_time":{"type":"string","format":"date-time","title":"Event Time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time of the event (ISO 8601 format with a timezone offset, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+02:00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"examples":["2024-12-31T08:00:00Z"]},"ok":{"type":"boolean","title":"Ok","description":"Is the status ok"},"type":{"type":"string","title":"Type","description":"Type of the status"},"remark":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remark","description":"extra remark about the status"}},"type":"object","required":["event_time","ok","type"],"title":"BookingExecutionStatus"}},"components/schemas/BookingMatch":{"id":"components/schemas/BookingMatch","kind":"json-schema","title":"BookingMatch","data":{"properties":{"booking_reference":{"anyOf":[{"$ref":"#/components/schemas/FieldMatchInput"},{"type":"null"}]},"name":{"anyOf":[{"$ref":"#/components/schemas/FieldMatchInput"},{"type":"null"}]}},"type":"object","title":"BookingMatch"}},"components/schemas/BookingMatchTarget":{"id":"components/schemas/BookingMatchTarget","kind":"json-schema","title":"BookingMatchTarget","data":{"properties":{"matches_all":{"items":{"$ref":"#/components/schemas/BookingMatch"},"type":"array","title":"Matches All"}},"type":"object","title":"BookingMatchTarget"}},"components/schemas/BookingOperation":{"id":"components/schemas/BookingOperation","kind":"json-schema","title":"BookingOperation","data":{"type":"string","enum":["CREATE","UPDATE","CANCEL"],"title":"BookingOperation"}},"components/schemas/BookingStatus":{"id":"components/schemas/BookingStatus","kind":"json-schema","title":"BookingStatus","data":{"type":"string","enum":["TO_REQUEST","REQUESTED","BOOKED","CANCELLED","REJECTED"],"title":"BookingStatus"}},"components/schemas/BookingTrip":{"id":"components/schemas/BookingTrip","kind":"json-schema","title":"BookingTrip","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Qargo Trip id"},"name":{"type":"string","title":"Name","description":"Qargo Trip name"},"status":{"$ref":"#/components/schemas/TripStatus","description":"Status of the trip"},"custom_fields":{"type":"object","title":"Custom Fields","description":"Store values for user defined fields"}},"type":"object","required":["id","name","status"],"title":"BookingTrip"}},"components/schemas/BookingVehicleType":{"id":"components/schemas/BookingVehicleType","kind":"json-schema","title":"BookingVehicleType","data":{"type":"string","enum":["ARTICULATED","ResourceType.VAN","ResourceType.RIGID","ResourceType.TRACTOR","TANK_CONTAINER","CURTAINSIDER","REEFER","BOX","CONTAINER","CHASSIS"],"title":"BookingVehicleType"}},"components/schemas/BuyerSellerCompanyOutput-Input":{"id":"components/schemas/BuyerSellerCompanyOutput-Input","kind":"json-schema","title":"BuyerSellerCompanyOutput","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The unique identifier of the company."},"is_archived":{"type":"boolean","title":"Is Archived","description":"Indicates whether this company is archived as buyer/seller of an consignment","default":false},"name":{"type":"string","title":"Name","description":"Name of the company.","examples":["Qargo"]},"legal_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Legal Name","description":"Legal name of the company.","examples":["Qargo Ltd"]},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"External reference to this company record","examples":["QARGO"]},"contacts":{"anyOf":[{"items":{"$ref":"#/components/schemas/CompanyContactOutput"},"type":"array"},{"type":"null"}],"title":"Contacts","description":"List of contacts associated with the company"},"locale":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Locale","description":"Locale of the company. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.","examples":["en","nl","en-GB","fr-BE"]},"billing_location":{"anyOf":[{"$ref":"#/components/schemas/LocationOutput"},{"type":"null"}],"description":"Billing address of the company."},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"Additional notes about the company.","examples":["Additional notes"]},"reference_numbers":{"$ref":"#/components/schemas/CompanyReferenceNumbers","description":"Reference numbers of the company"}},"type":"object","required":["id","name"],"title":"BuyerSellerCompanyOutput"}},"components/schemas/BuyerSellerCompanyOutput-Output":{"id":"components/schemas/BuyerSellerCompanyOutput-Output","kind":"json-schema","title":"BuyerSellerCompanyOutput","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The unique identifier of the company."},"is_archived":{"type":"boolean","title":"Is Archived","description":"Indicates whether this company is archived as buyer/seller of an consignment","default":false},"name":{"type":"string","title":"Name","description":"Name of the company.","examples":["Qargo"]},"legal_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Legal Name","description":"Legal name of the company.","examples":["Qargo Ltd"]},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"External reference to this company record","examples":["QARGO"]},"contacts":{"anyOf":[{"items":{"$ref":"#/components/schemas/CompanyContactOutput"},"type":"array"},{"type":"null"}],"title":"Contacts","description":"List of contacts associated with the company"},"locale":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Locale","description":"Locale of the company. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.","examples":["en","nl","en-GB","fr-BE"]},"billing_location":{"anyOf":[{"$ref":"#/components/schemas/LocationOutput"},{"type":"null"}],"description":"Billing address of the company."},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"Additional notes about the company.","examples":["Additional notes"]},"reference_numbers":{"$ref":"#/components/schemas/CompanyReferenceNumbers","description":"Reference numbers of the company"}},"type":"object","required":["id","name"],"title":"BuyerSellerCompanyOutput"}},"components/schemas/BuyerSellerField":{"id":"components/schemas/BuyerSellerField","kind":"json-schema","title":"BuyerSellerField","data":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"row_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Row Id"}},"type":"object","title":"BuyerSellerField"}},"components/schemas/CentralTransportNetworkConsignmentExtraFields":{"id":"components/schemas/CentralTransportNetworkConsignmentExtraFields","kind":"json-schema","title":"CentralTransportNetworkConsignmentExtraFields","data":{"properties":{"hub":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hub","description":"Central Transport Network hub"},"trunk":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Trunk","description":"Central Transport Network trunk"},"alternative_hubs":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Alternative Hubs","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alternative hubs as a comma separated list e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Central,South"},"children":[]}]}]}]}},"type":"object","title":"CentralTransportNetworkConsignmentExtraFields"}},"components/schemas/CentralTransportNetworkConsignmentInput":{"id":"components/schemas/CentralTransportNetworkConsignmentInput","kind":"json-schema","title":"CentralTransportNetworkConsignmentInput","data":{"properties":{"hub":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hub"},"trunk":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Trunk"}},"type":"object","title":"CentralTransportNetworkConsignmentInput"}},"components/schemas/ChargeApprovalInput":{"id":"components/schemas/ChargeApprovalInput","kind":"json-schema","title":"ChargeApprovalInput","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"ID of the charge to approve/reject"},"approval_status":{"$ref":"#/components/schemas/ChargeApprovalStatusInput","description":"Approval status of the charge","default":"APPROVED"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Comment for approval/rejection"}},"type":"object","required":["id"],"title":"ChargeApprovalInput"}},"components/schemas/ChargeApprovalStatus":{"id":"components/schemas/ChargeApprovalStatus","kind":"json-schema","title":"ChargeApprovalStatus","data":{"type":"string","enum":["TO_REQUEST","REQUESTED","REJECTED_INTERNAL","REJECTED","APPROVED"],"title":"ChargeApprovalStatus"}},"components/schemas/ChargeApprovalStatusInput":{"id":"components/schemas/ChargeApprovalStatusInput","kind":"json-schema","title":"ChargeApprovalStatusInput","data":{"type":"string","enum":["APPROVED","REJECTED"],"title":"ChargeApprovalStatusInput"}},"components/schemas/ChargeInput":{"id":"components/schemas/ChargeInput","kind":"json-schema","title":"ChargeInput","data":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the charge"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code of the charge"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Description of the charge"},"amount_excl_tax":{"anyOf":[{"type":"number"},{"type":"string"}],"title":"Amount Excl Tax","description":"Amount excluding tax"},"tax_rate":{"anyOf":[{"$ref":"#/components/schemas/TaxRateReference"},{"type":"null"}],"description":"Tax rate reference for this charge, defaults to tax rate on price list item."},"price_list_item":{"$ref":"#/components/schemas/PriceListItemReference","description":"Price list item reference for this charge"}},"type":"object","required":["amount_excl_tax","price_list_item"],"title":"ChargeInput"}},"components/schemas/ChargeOutput":{"id":"components/schemas/ChargeOutput","kind":"json-schema","title":"ChargeOutput","data":{"type":"object"}},"components/schemas/ChargeStatus":{"id":"components/schemas/ChargeStatus","kind":"json-schema","title":"ChargeStatus","data":{"type":"string","enum":["CREATED","DO_NOT_INVOICE","INVOICED","INVOICED_EXTERNAL","INVOICE_POSTED"],"title":"ChargeStatus","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoicing lifecycle of a charge."},"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":"CREATED: Not yet invoiced. Statuses outside this list are also reported as CREATED."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DO_NOT_INVOICE: Marked to be excluded from invoicing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INVOICED: On an invoice that has not been posted yet."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INVOICED_EXTERNAL: Invoiced outside Qargo."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INVOICE_POSTED: On a posted invoice."},"children":[]}]}]}]}]}},"components/schemas/ChargeWithApprovalOutput":{"id":"components/schemas/ChargeWithApprovalOutput","kind":"json-schema","title":"ChargeWithApprovalOutput","data":{"type":"object"}},"components/schemas/ChargesApprovalInput":{"id":"components/schemas/ChargesApprovalInput","kind":"json-schema","title":"ChargesApprovalInput","data":{"properties":{"charges":{"items":{"$ref":"#/components/schemas/ChargeApprovalInput"},"type":"array","title":"Charges"}},"type":"object","required":["charges"],"title":"ChargesApprovalInput"}},"components/schemas/ChassisProperties-Input":{"id":"components/schemas/ChassisProperties-Input","kind":"json-schema","title":"ChassisProperties","data":{"properties":{"tare_weight_kg":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Tare Weight Kg","description":"Tare weight of the chassis in kg","examples":[5000]},"exterior_length_m":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Exterior Length M","description":"Exterior length of the chassis in meter","examples":[12]},"exterior_width_m":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Exterior Width M","description":"Exterior width of the chassis in meter","examples":[2.5]},"exterior_height_m":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Exterior Height M","description":"Exterior height of the chassis in meter","examples":[1.5]},"gross_weight_vehicle_rating_weight_kg":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Gross Weight Vehicle Rating Weight Kg","description":"Gross vehicle weight rating of the chassis in kg","examples":[30000]},"license_plate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"License Plate","description":"License plate of the chassis"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"Model of the chassis"},"manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Manufacturer","description":"Manufacturer of the chassis"},"vin_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vin Number","description":"VIN number of the chassis"},"axle_configuration":{"anyOf":[{"type":"string","enum":["AC_12_TRAILER","AC_10_TRAILER","AC_8_TRAILER","AC_6_TRAILER","AC_4_TRAILER","AC_2_TRAILER"]},{"type":"null"}],"title":"Axle Configuration","description":"Axle configuration of the chassis"}},"type":"object","title":"ChassisProperties"}},"components/schemas/ChassisProperties-Output":{"id":"components/schemas/ChassisProperties-Output","kind":"json-schema","title":"ChassisProperties","data":{"properties":{"tare_weight_kg":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tare Weight Kg","description":"Tare weight of the chassis in kg","examples":[5000]},"exterior_length_m":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Exterior Length M","description":"Exterior length of the chassis in meter","examples":[12]},"exterior_width_m":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Exterior Width M","description":"Exterior width of the chassis in meter","examples":[2.5]},"exterior_height_m":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Exterior Height M","description":"Exterior height of the chassis in meter","examples":[1.5]},"gross_weight_vehicle_rating_weight_kg":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Gross Weight Vehicle Rating Weight Kg","description":"Gross vehicle weight rating of the chassis in kg","examples":[30000]},"license_plate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"License Plate","description":"License plate of the chassis"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"Model of the chassis"},"manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Manufacturer","description":"Manufacturer of the chassis"},"vin_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vin Number","description":"VIN number of the chassis"},"axle_configuration":{"anyOf":[{"type":"string","enum":["AC_12_TRAILER","AC_10_TRAILER","AC_8_TRAILER","AC_6_TRAILER","AC_4_TRAILER","AC_2_TRAILER"]},{"type":"null"}],"title":"Axle Configuration","description":"Axle configuration of the chassis"}},"type":"object","title":"ChassisProperties"}},"components/schemas/ChassisResourceInput":{"id":"components/schemas/ChassisResourceInput","kind":"json-schema","title":"ChassisResourceInput","data":{"properties":{"is_archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Archived","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reactivate a previously archived resource, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to archive it. Only takes effect when included in the request; omit it to leave the archive state unchanged."},"children":[]}]}]}]},"billing_entity":{"anyOf":[{"$ref":"#/components/schemas/BillingEntityReference"},{"type":"null"}],"description":"Billing entity associated with the resource, defaults to default billing entity if not provided"},"extras":{"anyOf":[{"items":{"$ref":"#/components/schemas/ResourceExtraInput"},"type":"array"},{"type":"null"}],"title":"Extras","description":"Stop extras this resource is compatible with. Replaces the existing list when provided. Send an empty list to clear all compatible extras."},"name":{"type":"string","title":"Name","description":"Name of the resource"},"external_id":{"type":"string","title":"External Id","description":"External identifier of the resource","default":""},"locale":{"anyOf":[{"type":"string","pattern":"^[a-z]{2}(-[A-Z]{2})?$"},{"type":"null"}],"title":"Locale","description":"Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.","examples":["en","nl","en-GB","fr-BE"]},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code of the resource"},"note":{"type":"string","title":"Note","description":"Note about the resource","default":""},"custom_fields":{"type":"object","title":"Custom Fields","description":"User defined additional fields for this resource"},"subcontractor":{"anyOf":[{"$ref":"#/components/schemas/CompanyReference"},{"type":"null"}],"description":"Company linked to the resource"},"integrations":{"anyOf":[{"additionalProperties":{"type":"object"},"type":"object"},{"type":"null"}],"title":"Integrations","description":"Related integrations for the resource. The key is the unique code of the integration in Qargo","examples":[{"addsecure1234":{"active":true,"object_id":"1234"}}]},"chassis":{"anyOf":[{"$ref":"#/components/schemas/ChassisProperties-Input"},{"type":"null"}],"description":"Chassis specific properties"}},"type":"object","required":["name"],"title":"ChassisResourceInput"}},"components/schemas/ChassisResourceOutput":{"id":"components/schemas/ChassisResourceOutput","kind":"json-schema","title":"ChassisResourceOutput","data":{"properties":{"row_id":{"type":"string","format":"uuid","title":"Row Id","description":"Identifier of the reference"},"name":{"type":"string","title":"Name","description":"Name of the resource"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":"External identifier of the resource"},"locale":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Locale","description":"Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.","examples":["en","nl","en-GB","fr-BE"]},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code of the resource"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"Note about the resource"},"custom_fields":{"type":"object","title":"Custom Fields","description":"User defined additional fields for this resource"},"subcontractor":{"anyOf":[{"$ref":"#/components/schemas/CompanyReference"},{"type":"null"}],"description":"Company linked to the resource"},"integrations":{"anyOf":[{"additionalProperties":{"type":"object"},"type":"object"},{"type":"null"}],"title":"Integrations","description":"Related integrations for the resource. The key is the unique code of the integration in Qargo","examples":[{"addsecure1234":{"active":true,"object_id":"1234"}}]},"billing_entity":{"anyOf":[{"$ref":"#/components/schemas/BillingEntity"},{"type":"null"}],"description":"Billing entity associated with the resource"},"extras":{"items":{"$ref":"#/components/schemas/ResourceExtraOutput"},"type":"array","title":"Extras","description":"Stop extras this resource is compatible with"},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Active","description":"Is the resource active"},"is_external_resource":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is External Resource","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Read-only. True if this is a non-owned (subcontractor) resource. When this resource appears inside a trip, name / license_plate / container_number reflect the per-trip override value if one was set on the resource allocation; otherwise the resource master value is returned. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the value is not yet projected — treat as internal for backwards compatibility."},"children":[]}]}]}],"examples":[true]},"timestamp_updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp Updated","description":"Timestamp of the last update of the resource"},"resource_groups":{"items":{"$ref":"#/components/schemas/ResourceGroupOutput"},"type":"array","title":"Resource Groups","description":"Resource groups this resource currently belongs to (deduplicated and sorted by name). A resource can belong to more than one group. Active allocations are included regardless of their validity window (scheduled, future, or expired); archived allocations are excluded."},"chassis":{"anyOf":[{"$ref":"#/components/schemas/ChassisProperties-Output"},{"type":"null"}],"description":"Chassis specific properties"}},"type":"object","required":["row_id","name"],"title":"ChassisResourceOutput"}},"components/schemas/ChepOrderInput":{"id":"components/schemas/ChepOrderInput","kind":"json-schema","title":"ChepOrderInput","data":{"properties":{"load_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Load Id"}},"type":"object","title":"ChepOrderInput"}},"components/schemas/CommercialInvoiceInput":{"id":"components/schemas/CommercialInvoiceInput","kind":"json-schema","title":"CommercialInvoiceInput","data":{"properties":{"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value"}},"type":"object","title":"CommercialInvoiceInput"}},"components/schemas/CompanyBillingEntity":{"id":"components/schemas/CompanyBillingEntity","kind":"json-schema","title":"CompanyBillingEntity","data":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"Unique identifier of the billing entity associated with the company."},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code of the billing entity associated with the company."},"accounting_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Accounting Code","description":"Accounting code linked to the billing entity for the company."}},"type":"object","title":"CompanyBillingEntity"}},"components/schemas/CompanyContactInput":{"id":"components/schemas/CompanyContactInput","kind":"json-schema","title":"CompanyContactInput","data":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"Unique identifier of the contact. When creating a new contact, this field should be omitted or set to null. This field only needs to be provided when updating an existing contact of the company"},"is_archived":{"type":"boolean","title":"Is Archived","description":"Indicates whether a contact should be archived. Set to true to archive the contact.","default":false},"roles":{"items":{"$ref":"#/components/schemas/ContactType"},"type":"array","title":"Roles","description":"List of roles associated with the contact."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the contact person associated with the company.","examples":["John Doe"]},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"Additional notes about the contact person."},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email","description":"Email address of the contact person."},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Phone number of the contact person. Expected format is E.164 (e.g., +32485123456)."},"children":[]}]}]}],"examples":["+32485123456"]}},"type":"object","title":"CompanyContactInput"}},"components/schemas/CompanyContactOutput":{"id":"components/schemas/CompanyContactOutput","kind":"json-schema","title":"CompanyContactOutput","data":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"Unique identifier of the contact"},"roles":{"items":{"$ref":"#/components/schemas/ContactType"},"type":"array","title":"Roles","description":"List of roles associated with the contact."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the contact person associated with the company.","examples":["John Doe"]},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"Additional notes about the contact person."},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email","description":"Email address of the contact person."},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number","description":"Phone number of the contact person.","examples":["+32485123456"]}},"type":"object","title":"CompanyContactOutput"}},"components/schemas/CompanyDetailOutput":{"id":"components/schemas/CompanyDetailOutput","kind":"json-schema","title":"CompanyDetailOutput","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The unique identifier of the company."},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"External reference to this company record","examples":[""]},"currency":{"type":"string","title":"Currency","description":"Currency of the company (ISO 4217, 3 letter code)","examples":["EUR"]},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"Custom fields of the company"},"is_customer":{"type":"boolean","title":"Is Customer","description":"Indicate that this company is a customer","default":false},"is_subcontractor":{"type":"boolean","title":"Is Subcontractor","description":"Indicate that this company is a subcontractor (supplier)","default":false},"is_buyer_or_seller":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Buyer Or Seller","description":"Indicates that this company is a buyer or seller of a consignment"},"name":{"type":"string","title":"Name","description":"Name of the company.","examples":["John Doe"]},"legal_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Legal Name","description":"Legal name of the company.","examples":["John Doe"]},"vat_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vat Number","description":"VAT number of the company.","examples":["BE1234.123.123"]},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"Additional notes about the company","examples":[""]},"tax_type":{"anyOf":[{"$ref":"#/components/schemas/TaxTypeEnum"},{"type":"null"}],"description":"default tax type of the company","examples":["VAT"]},"status":{"$ref":"#/components/schemas/CustomerStatus","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status indicates whether an order can be linked to this customer. The available statuses are:"},"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":"code","inline":true,"attributes":{"content":"PROSPECT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The company is a potential customer but not yet approved. Only quotes can be created; no orders can be placed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT_APPROVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The company is not yet fully approved as a customer. This is an intermediary step between PROSPECT and APPROVED. Same permissions as PROSPECT apply."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPROVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The customer is approved. Orders can be placed without restrictions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WARNING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The customer is approved, but a warning is triggered when attempting to create an order  in Qargo. The operator can dismiss the warning and proceed with the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BLOCKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The customer is blocked; no new orders can be created."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a company representing other companies, it can only create orders if it holds the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPROVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]}]}]}],"default":"APPROVED","examples":["APPROVED"]},"accounting_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Accounting Code","description":"Default customer accounting code linked to the accounting system. Please use the accounting codes on the billing entities, as these are split per billing entity and between sales/purchase sides.","examples":["1234"]},"billing_location":{"anyOf":[{"$ref":"#/components/schemas/LocationOutput"},{"type":"null"}],"description":"Billing address of the company."},"payment_term":{"anyOf":[{"$ref":"#/components/schemas/BasePaymentTerm"},{"type":"null"}],"description":"Payment term information of the company"},"locale":{"type":"string","title":"Locale","description":"Locale of the company. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.","examples":["en","nl","en-GB","fr-BE"]},"archived_customer":{"type":"boolean","title":"Archived Customer","description":"Indicate that this company is archived as a customer"},"archived_subcontractor":{"type":"boolean","title":"Archived Subcontractor","description":"Indicate that this company is archived as a subcontractor"},"archived_buyer_or_seller":{"type":"boolean","title":"Archived Buyer Or Seller","description":"Indicates that this company is archived as buyer/seller of a consignment"},"credit_policy":{"anyOf":[{"$ref":"#/components/schemas/CreditPolicyOutput"},{"type":"null"}],"description":"Credit policy of the customer"},"default_invoice_customer":{"anyOf":[{"$ref":"#/components/schemas/api__accounting__models__company__CompanyReferenceOutput"},{"type":"null"}],"description":"Default invoice customer (bill-to) for this company. When set, charges for this customer are billed to the referenced company instead."},"reference_numbers":{"$ref":"#/components/schemas/CompanyReferenceNumbers","description":"Reference numbers of the company"},"bank_accounts":{"items":{"$ref":"#/components/schemas/BankAccount"},"type":"array","title":"Bank Accounts","description":"List of associated bank accounts."},"contacts":{"anyOf":[{"items":{"$ref":"#/components/schemas/CompanyContactOutput"},"type":"array"},{"type":"null"}],"title":"Contacts","description":"List of contacts associated with the company"},"sales":{"$ref":"#/components/schemas/SalesCompanyFields-Output","description":"Sales related fields of the company"},"purchase":{"$ref":"#/components/schemas/PurchaseCompanyFields-Output","description":"Purchase related fields of the company"},"timestamp_updated":{"type":"string","format":"date-time","title":"Timestamp Updated","description":"The date and time when the company was last updated."},"is_blocked":{"type":"boolean","title":"Is Blocked","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to true to disallow new order creation for companies representing companies."},"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":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Deprecated in favor of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"default":false,"deprecated":true},"credit_limit_total":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Credit Limit Total","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The limit for total amount that has been invoiced but not paid. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"credit_policy.limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}],"deprecated":true,"examples":[12000]}},"type":"object","required":["id","currency","name","locale","archived_customer","archived_subcontractor","archived_buyer_or_seller","timestamp_updated"],"title":"CompanyDetailOutput"}},"components/schemas/CompanyDocumentOutput":{"id":"components/schemas/CompanyDocumentOutput","kind":"json-schema","title":"CompanyDocumentOutput","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier of the document"},"name":{"type":"string","title":"Name","description":"Name of the document"},"type":{"anyOf":[{"$ref":"#/components/schemas/SubcontractorDocumentWithValidityTypeInput"},{"$ref":"#/components/schemas/SubcontractorInsuranceDocumentTypeInput"},{"$ref":"#/components/schemas/CustomerDocumentTypeInput"},{"$ref":"#/components/schemas/SubcontractorDocumentWithoutValidityTypeInput"}],"title":"Type","description":"Type of the document."},"download_url":{"type":"string","title":"Download Url","description":"Relative URL from the base URL to download the document","default":""},"subject_type":{"type":"string","title":"Subject Type","description":"Linked subject of the document"},"content_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content Type","description":"Content type of the document"},"validity":{"anyOf":[{"$ref":"#/components/schemas/CompanyValidityOutput"},{"type":"null"}],"description":"Validity information associated with the document."}},"type":"object","required":["id","name","type","subject_type"],"title":"CompanyDocumentOutput"}},"components/schemas/CompanyInput":{"id":"components/schemas/CompanyInput","kind":"json-schema","title":"CompanyInput","data":{"properties":{"is_customer":{"type":"boolean","title":"Is Customer","description":"Indicate that this company is a customer","default":false},"is_buyer_or_seller":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Buyer Or Seller","description":"Indicates that this company is a buyer or seller of a consignment"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the company.","examples":["John Doe"]},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"External reference to this company record","examples":[""]},"currency":{"type":"string","title":"Currency","description":"Currency of the company (ISO 4217, 3 letter code)","examples":["EUR"]},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"Custom fields of the company"},"credit_policy":{"anyOf":[{"$ref":"#/components/schemas/CreditPolicyInput"},{"type":"null"}],"description":"Credit policy of the customer"},"default_invoice_customer_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Default Invoice Customer Id","description":"ID of the default invoice customer (bill-to) for this company. When set, charges for this customer are billed to the referenced company instead."},"is_subcontractor":{"type":"boolean","title":"Is Subcontractor","description":"Indicate that this company is a subcontractor (supplier)","default":false},"archived_customer":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Archived Customer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to archive the customer role of this company, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reactivate it. Has no effect if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_customer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"archived_subcontractor":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Archived Subcontractor","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to archive the subcontractor role of this company, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reactivate it. Has no effect if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_subcontractor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"legal_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Legal Name","description":"Legal name of the company.","examples":["John Doe"]},"locale":{"anyOf":[{"type":"string","pattern":"^[a-z]{2}(-[A-Z]{2})?$"},{"type":"null"}],"title":"Locale","description":"Locale of the company. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.","examples":["en","nl","en-GB","fr-BE"]},"vat_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vat Number","description":"VAT number of the company.","examples":["BE1234.123.123"]},"reference_numbers":{"anyOf":[{"$ref":"#/components/schemas/CompanyReferenceNumbers"},{"type":"null"}],"description":"Reference numbers of the company"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"Additional notes about the company","examples":[""]},"tax_type":{"anyOf":[{"$ref":"#/components/schemas/TaxTypeEnum"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESCRIPTION_HERE"},"children":[]}]}]}],"default":"VAT","examples":["VAT"]},"bank_accounts":{"anyOf":[{"items":{"$ref":"#/components/schemas/BankAccount"},"type":"array"},{"type":"null"}],"title":"Bank Accounts","description":"List of associated bank accounts.","default":[]},"accounting_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Accounting Code","description":"Code linked to the accounting system","examples":["1234"]},"billing_location":{"anyOf":[{"$ref":"#/components/schemas/BillingLocation"},{"type":"null"}],"description":"Billing address of the company."},"payment_term":{"anyOf":[{"$ref":"#/components/schemas/BasePaymentTerm"},{"type":"null"}],"description":"Payment term information of the company"},"contacts":{"anyOf":[{"items":{"$ref":"#/components/schemas/CompanyContactInput"},"type":"array"},{"type":"null"}],"title":"Contacts","description":"List of contacts associated with the company"},"sales":{"$ref":"#/components/schemas/SalesCompanyFields-Input","description":"Sales related fields of the company"},"purchase":{"$ref":"#/components/schemas/PurchaseCompanyFields-Input","description":"Purchase related fields of the company"},"credit_limit_total":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Credit Limit Total","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The limit for total amount that has been invoiced but not paid. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"credit_policy.limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}],"deprecated":true,"examples":[12000]},"is_blocked":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Blocked","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to true to disallow new order creation for companies representing companies."},"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":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Deprecated in favor of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sales"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields.an update of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will always prevail over "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_blocked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" update."},"children":[]}]}]}],"deprecated":true},"status":{"anyOf":[{"$ref":"#/components/schemas/CustomerStatus"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status indicates whether an order can be linked to this customer. The available statuses are:"},"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":"code","inline":true,"attributes":{"content":"PROSPECT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The company is a potential customer but not yet approved. Only quotes can be created; no orders can be placed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT_APPROVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The company is not yet fully approved as a customer. This is an intermediary step between PROSPECT and APPROVED. Same permissions as PROSPECT apply."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPROVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The customer is approved. Orders can be placed without restrictions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WARNING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The customer is approved, but a warning is triggered when attempting to create an order  in Qargo. The operator can dismiss the warning and proceed with the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BLOCKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The customer is blocked; no new orders can be created."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a company representing other companies, it can only create orders if it holds the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPROVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Deprecated in favor of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sales"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"children":[]}]}]}],"deprecated":true,"examples":["APPROVED"]}},"type":"object","required":["currency"],"title":"CompanyInput"}},"components/schemas/CompanyMatch":{"id":"components/schemas/CompanyMatch","kind":"json-schema","title":"CompanyMatch","data":{"properties":{"name":{"anyOf":[{"$ref":"#/components/schemas/FieldMatchInput"},{"type":"null"}]},"code":{"anyOf":[{"$ref":"#/components/schemas/FieldMatchInput"},{"type":"null"}]}},"type":"object","title":"CompanyMatch"}},"components/schemas/CompanyOutput-Input":{"id":"components/schemas/CompanyOutput-Input","kind":"json-schema","title":"CompanyOutput","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The unique identifier of the company."},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"External reference to this company record","examples":[""]},"currency":{"type":"string","title":"Currency","description":"Currency of the company (ISO 4217, 3 letter code)","examples":["EUR"]},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"Custom fields of the company"},"is_customer":{"type":"boolean","title":"Is Customer","description":"Indicate that this company is a customer","default":false},"is_subcontractor":{"type":"boolean","title":"Is Subcontractor","description":"Indicate that this company is a subcontractor (supplier)","default":false},"is_buyer_or_seller":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Buyer Or Seller","description":"Indicates that this company is a buyer or seller of a consignment"},"name":{"type":"string","title":"Name","description":"Name of the company.","examples":["John Doe"]},"legal_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Legal Name","description":"Legal name of the company.","examples":["John Doe"]},"vat_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vat Number","description":"VAT number of the company.","examples":["BE1234.123.123"]},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"Additional notes about the company","examples":[""]},"tax_type":{"anyOf":[{"$ref":"#/components/schemas/TaxTypeEnum"},{"type":"null"}],"description":"default tax type of the company","examples":["VAT"]},"status":{"$ref":"#/components/schemas/CustomerStatus","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status indicates whether an order can be linked to this customer. The available statuses are:"},"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":"code","inline":true,"attributes":{"content":"PROSPECT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The company is a potential customer but not yet approved. Only quotes can be created; no orders can be placed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT_APPROVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The company is not yet fully approved as a customer. This is an intermediary step between PROSPECT and APPROVED. Same permissions as PROSPECT apply."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPROVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The customer is approved. Orders can be placed without restrictions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WARNING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The customer is approved, but a warning is triggered when attempting to create an order  in Qargo. The operator can dismiss the warning and proceed with the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BLOCKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The customer is blocked; no new orders can be created."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a company representing other companies, it can only create orders if it holds the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPROVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]}]}]}],"default":"APPROVED","examples":["APPROVED"]},"accounting_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Accounting Code","description":"Default customer accounting code linked to the accounting system. Please use the accounting codes on the billing entities, as these are split per billing entity and between sales/purchase sides.","examples":["1234"]},"billing_location":{"anyOf":[{"$ref":"#/components/schemas/LocationOutput"},{"type":"null"}],"description":"Billing address of the company."},"payment_term":{"anyOf":[{"$ref":"#/components/schemas/BasePaymentTerm"},{"type":"null"}],"description":"Payment term information of the company"},"locale":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Locale","description":"Locale of the company. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.","examples":["en","nl","en-GB","fr-BE"]},"reference_numbers":{"$ref":"#/components/schemas/CompanyReferenceNumbers","description":"Reference numbers of the company"},"bank_accounts":{"items":{"$ref":"#/components/schemas/BankAccount"},"type":"array","title":"Bank Accounts","description":"List of associated bank accounts."},"contacts":{"anyOf":[{"items":{"$ref":"#/components/schemas/CompanyContactOutput"},"type":"array"},{"type":"null"}],"title":"Contacts","description":"List of contacts associated with the company"},"is_blocked":{"type":"boolean","title":"Is Blocked","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to true to disallow new order creation for companies representing companies."},"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":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Deprecated in favor of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"default":false,"deprecated":true}},"type":"object","required":["id","currency","name"],"title":"CompanyOutput"}},"components/schemas/CompanyOutput-Output":{"id":"components/schemas/CompanyOutput-Output","kind":"json-schema","title":"CompanyOutput","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The unique identifier of the company."},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"External reference to this company record","examples":[""]},"currency":{"type":"string","title":"Currency","description":"Currency of the company (ISO 4217, 3 letter code)","examples":["EUR"]},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"Custom fields of the company"},"is_customer":{"type":"boolean","title":"Is Customer","description":"Indicate that this company is a customer","default":false},"is_subcontractor":{"type":"boolean","title":"Is Subcontractor","description":"Indicate that this company is a subcontractor (supplier)","default":false},"is_buyer_or_seller":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Buyer Or Seller","description":"Indicates that this company is a buyer or seller of a consignment"},"name":{"type":"string","title":"Name","description":"Name of the company.","examples":["John Doe"]},"legal_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Legal Name","description":"Legal name of the company.","examples":["John Doe"]},"vat_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vat Number","description":"VAT number of the company.","examples":["BE1234.123.123"]},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"Additional notes about the company","examples":[""]},"tax_type":{"anyOf":[{"$ref":"#/components/schemas/TaxTypeEnum"},{"type":"null"}],"description":"default tax type of the company","examples":["VAT"]},"status":{"$ref":"#/components/schemas/CustomerStatus","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status indicates whether an order can be linked to this customer. The available statuses are:"},"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":"code","inline":true,"attributes":{"content":"PROSPECT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The company is a potential customer but not yet approved. Only quotes can be created; no orders can be placed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT_APPROVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The company is not yet fully approved as a customer. This is an intermediary step between PROSPECT and APPROVED. Same permissions as PROSPECT apply."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPROVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The customer is approved. Orders can be placed without restrictions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WARNING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The customer is approved, but a warning is triggered when attempting to create an order  in Qargo. The operator can dismiss the warning and proceed with the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BLOCKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The customer is blocked; no new orders can be created."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a company representing other companies, it can only create orders if it holds the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPROVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]}]}]}],"default":"APPROVED","examples":["APPROVED"]},"accounting_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Accounting Code","description":"Default customer accounting code linked to the accounting system. Please use the accounting codes on the billing entities, as these are split per billing entity and between sales/purchase sides.","examples":["1234"]},"billing_location":{"anyOf":[{"$ref":"#/components/schemas/LocationOutput"},{"type":"null"}],"description":"Billing address of the company."},"payment_term":{"anyOf":[{"$ref":"#/components/schemas/BasePaymentTerm"},{"type":"null"}],"description":"Payment term information of the company"},"locale":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Locale","description":"Locale of the company. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.","examples":["en","nl","en-GB","fr-BE"]},"reference_numbers":{"$ref":"#/components/schemas/CompanyReferenceNumbers","description":"Reference numbers of the company"},"bank_accounts":{"items":{"$ref":"#/components/schemas/BankAccount"},"type":"array","title":"Bank Accounts","description":"List of associated bank accounts."},"contacts":{"anyOf":[{"items":{"$ref":"#/components/schemas/CompanyContactOutput"},"type":"array"},{"type":"null"}],"title":"Contacts","description":"List of contacts associated with the company"},"is_blocked":{"type":"boolean","title":"Is Blocked","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to true to disallow new order creation for companies representing companies."},"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":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Deprecated in favor of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"default":false,"deprecated":true}},"type":"object","required":["id","currency","name"],"title":"CompanyOutput"}},"components/schemas/CompanyPartialInput":{"id":"components/schemas/CompanyPartialInput","kind":"json-schema","title":"CompanyPartialInput","data":{"properties":{"is_customer":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Customer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicate that this company is a customer. At least one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_customer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_subcontractor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be set."},"children":[]}]}]}]},"is_buyer_or_seller":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Buyer Or Seller","description":"Indicates that this company is a buyer or seller of a consignment"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the company.","examples":["John Doe"]},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"External reference to this company record","examples":[""]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","description":"Currency of the company (ISO 4217, 3 letter code)","examples":["EUR"]},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"Custom fields of the company"},"credit_policy":{"anyOf":[{"$ref":"#/components/schemas/CreditPolicyInput"},{"type":"null"}],"description":"Credit policy of the customer"},"default_invoice_customer_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Default Invoice Customer Id","description":"ID of the default invoice customer (bill-to) for this company. When set, charges for this customer are billed to the referenced company instead."},"is_subcontractor":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Subcontractor","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicate that this company is a subcontractor (supplier). At least one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_customer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_subcontractor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be set."},"children":[]}]}]}]},"archived_customer":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Archived Customer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to archive the customer role of this company, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reactivate it. Has no effect if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_customer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"archived_subcontractor":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Archived Subcontractor","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to archive the subcontractor role of this company, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reactivate it. Has no effect if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_subcontractor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"legal_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Legal Name","description":"Legal name of the company.","examples":["John Doe"]},"locale":{"anyOf":[{"type":"string","pattern":"^[a-z]{2}(-[A-Z]{2})?$"},{"type":"null"}],"title":"Locale","description":"Locale of the company. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.","examples":["en","nl","en-GB","fr-BE"]},"vat_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vat Number","description":"VAT number of the company.","examples":["BE1234.123.123"]},"reference_numbers":{"anyOf":[{"$ref":"#/components/schemas/CompanyReferenceNumbers"},{"type":"null"}],"description":"Reference numbers of the company"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"Additional notes about the company","examples":[""]},"tax_type":{"anyOf":[{"$ref":"#/components/schemas/TaxTypeEnum"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESCRIPTION_HERE"},"children":[]}]}]}],"examples":["VAT"]},"bank_accounts":{"anyOf":[{"items":{"$ref":"#/components/schemas/BankAccount"},"type":"array"},{"type":"null"}],"title":"Bank Accounts","description":"List of associated bank accounts."},"accounting_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Accounting Code","description":"Code linked to the accounting system","examples":["1234"]},"billing_location":{"anyOf":[{"$ref":"#/components/schemas/BillingLocation"},{"type":"null"}],"description":"Billing address of the company."},"payment_term":{"anyOf":[{"$ref":"#/components/schemas/BasePaymentTerm"},{"type":"null"}],"description":"Payment term information of the company"},"contacts":{"anyOf":[{"items":{"$ref":"#/components/schemas/CompanyContactInput"},"type":"array"},{"type":"null"}],"title":"Contacts","description":"List of contacts associated with the company"},"sales":{"$ref":"#/components/schemas/SalesCompanyFields-Input","description":"Sales related fields of the company"},"purchase":{"$ref":"#/components/schemas/PurchaseCompanyFields-Input","description":"Purchase related fields of the company"},"credit_limit_total":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Credit Limit Total","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The limit for total amount that has been invoiced but not paid. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"credit_policy.limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}],"deprecated":true,"examples":[12000]},"is_blocked":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Blocked","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to true to disallow new order creation for companies representing companies."},"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":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Deprecated in favor of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sales"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields.an update of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will always prevail over "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_blocked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" update."},"children":[]}]}]}],"deprecated":true},"status":{"anyOf":[{"$ref":"#/components/schemas/CustomerStatus"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status indicates whether an order can be linked to this customer. The available statuses are:"},"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":"code","inline":true,"attributes":{"content":"PROSPECT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The company is a potential customer but not yet approved. Only quotes can be created; no orders can be placed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT_APPROVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The company is not yet fully approved as a customer. This is an intermediary step between PROSPECT and APPROVED. Same permissions as PROSPECT apply."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPROVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The customer is approved. Orders can be placed without restrictions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WARNING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The customer is approved, but a warning is triggered when attempting to create an order  in Qargo. The operator can dismiss the warning and proceed with the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BLOCKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The customer is blocked; no new orders can be created."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a company representing other companies, it can only create orders if it holds the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPROVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Deprecated in favor of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sales"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"children":[]}]}]}],"deprecated":true,"examples":["APPROVED"]}},"type":"object","title":"CompanyPartialInput"}},"components/schemas/CompanyReference":{"id":"components/schemas/CompanyReference","kind":"json-schema","title":"CompanyReference","data":{"properties":{"row_id":{"type":"string","format":"uuid","title":"Row Id","description":"Identifier of the reference"}},"type":"object","required":["row_id"],"title":"CompanyReference"}},"components/schemas/CompanyReferenceNumbers":{"id":"components/schemas/CompanyReferenceNumbers","kind":"json-schema","title":"CompanyReferenceNumbers","data":{"properties":{"eori_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Eori Number","description":"Economic Operator Registration and Identification","examples":[""]},"duns_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Duns Number","description":"D-U-N-S Number","examples":[""]},"scac_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scac Code","description":"Standard Carrier Alpha Code","examples":[""]},"company_registration_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Registration Number","description":"Company Registration Number","examples":[""]},"tss_registration_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tss Registration Number","description":"TSS registration number","examples":[""]}},"type":"object","title":"CompanyReferenceNumbers"}},"components/schemas/CompanySummaryOutput":{"id":"components/schemas/CompanySummaryOutput","kind":"json-schema","title":"CompanySummaryOutput","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The unique identifier of the company."},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"External reference to this company record","examples":[""]},"currency":{"type":"string","title":"Currency","description":"Currency of the company (ISO 4217, 3 letter code)","examples":["EUR"]},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"Custom fields of the company"},"is_customer":{"type":"boolean","title":"Is Customer","description":"Indicate that this company is a customer","default":false},"is_subcontractor":{"type":"boolean","title":"Is Subcontractor","description":"Indicate that this company is a subcontractor (supplier)","default":false},"is_buyer_or_seller":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Buyer Or Seller","description":"Indicates that this company is a buyer or seller of a consignment"},"name":{"type":"string","title":"Name","description":"Name of the company.","examples":["John Doe"]},"legal_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Legal Name","description":"Legal name of the company.","examples":["John Doe"]},"vat_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vat Number","description":"VAT number of the company.","examples":["BE1234.123.123"]},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"Additional notes about the company","examples":[""]},"tax_type":{"anyOf":[{"$ref":"#/components/schemas/TaxTypeEnum"},{"type":"null"}],"description":"default tax type of the company","examples":["VAT"]},"status":{"$ref":"#/components/schemas/CustomerStatus","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status indicates whether an order can be linked to this customer. The available statuses are:"},"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":"code","inline":true,"attributes":{"content":"PROSPECT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The company is a potential customer but not yet approved. Only quotes can be created; no orders can be placed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT_APPROVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The company is not yet fully approved as a customer. This is an intermediary step between PROSPECT and APPROVED. Same permissions as PROSPECT apply."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPROVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The customer is approved. Orders can be placed without restrictions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WARNING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The customer is approved, but a warning is triggered when attempting to create an order  in Qargo. The operator can dismiss the warning and proceed with the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BLOCKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The customer is blocked; no new orders can be created."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a company representing other companies, it can only create orders if it holds the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPROVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]}]}]}],"default":"APPROVED","examples":["APPROVED"]},"accounting_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Accounting Code","description":"Default customer accounting code linked to the accounting system. Please use the accounting codes on the billing entities, as these are split per billing entity and between sales/purchase sides.","examples":["1234"]},"billing_location":{"anyOf":[{"$ref":"#/components/schemas/LocationOutput"},{"type":"null"}],"description":"Billing address of the company."},"payment_term":{"anyOf":[{"$ref":"#/components/schemas/BasePaymentTerm"},{"type":"null"}],"description":"Payment term information of the company"},"is_blocked":{"type":"boolean","title":"Is Blocked","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to true to disallow new order creation for companies representing companies."},"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":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Deprecated in favor of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"default":false,"deprecated":true}},"type":"object","required":["id","currency","name"],"title":"CompanySummaryOutput"}},"components/schemas/CompanyValidity":{"id":"components/schemas/CompanyValidity","kind":"json-schema","title":"CompanyValidity","data":{"properties":{"start_time":{"type":"string","format":"date-time","title":"Start Time","description":"Start time of the validity"},"end_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Time","description":"End time of the validity from a planning perspective"},"legal_end_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Legal End Time","description":"End time of the validity from a legal perspective"},"generate_unavailability":{"type":"boolean","title":"Generate Unavailability","description":"Generate a planning unavailability once the validity end time has passed","default":false},"type":{"$ref":"#/components/schemas/SubcontractorValidityReason"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":"ID of the validity in the external master data system"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"}},"type":"object","required":["start_time","type"],"title":"CompanyValidity"}},"components/schemas/CompanyValidityInput":{"id":"components/schemas/CompanyValidityInput","kind":"json-schema","title":"CompanyValidityInput","data":{"properties":{"start_time":{"type":"string","format":"date-time","title":"Start Time","description":"Start time of the validity"},"end_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Time","description":"End time of the validity from a planning perspective"},"legal_end_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Legal End Time","description":"End time of the validity from a legal perspective"},"generate_unavailability":{"type":"boolean","title":"Generate Unavailability","description":"Generate a planning unavailability once the validity end time has passed","default":false},"type":{"$ref":"#/components/schemas/SubcontractorValidityReason"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":"ID of the validity in the external master data system"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"documents":{"items":{"$ref":"#/components/schemas/UploadedDocumentBase_Union_SubcontractorDocumentWithValidityTypeInput__SubcontractorInsuranceDocumentTypeInput__"},"type":"array","title":"Documents","description":"List of documents associated with the validity"}},"type":"object","required":["start_time","type"],"title":"CompanyValidityInput"}},"components/schemas/CompanyValidityOutput":{"id":"components/schemas/CompanyValidityOutput","kind":"json-schema","title":"CompanyValidityOutput","data":{"properties":{"start_time":{"type":"string","format":"date-time","title":"Start Time","description":"Start time of the validity"},"end_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Time","description":"End time of the validity from a planning perspective"},"legal_end_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Legal End Time","description":"End time of the validity from a legal perspective"},"generate_unavailability":{"type":"boolean","title":"Generate Unavailability","description":"Generate a planning unavailability once the validity end time has passed","default":false},"type":{"$ref":"#/components/schemas/SubcontractorValidityReason"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":"ID of the validity in the external master data system"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier of the validity"}},"type":"object","required":["start_time","type","id"],"title":"CompanyValidityOutput"}},"components/schemas/ConsignmentBuyerSellerOutput-Input":{"id":"components/schemas/ConsignmentBuyerSellerOutput-Input","kind":"json-schema","title":"ConsignmentBuyerSellerOutput","data":{"properties":{"company":{"anyOf":[{"$ref":"#/components/schemas/BuyerSellerCompanyOutput-Input"},{"type":"null"}],"description":"Company information for the buyer/seller"},"eori_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Eori Number","description":"Economic Operator Registration and Identification"}},"type":"object","title":"ConsignmentBuyerSellerOutput"}},"components/schemas/ConsignmentBuyerSellerOutput-Output":{"id":"components/schemas/ConsignmentBuyerSellerOutput-Output","kind":"json-schema","title":"ConsignmentBuyerSellerOutput","data":{"properties":{"company":{"anyOf":[{"$ref":"#/components/schemas/BuyerSellerCompanyOutput-Output"},{"type":"null"}],"description":"Company information for the buyer/seller"},"eori_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Eori Number","description":"Economic Operator Registration and Identification"}},"type":"object","title":"ConsignmentBuyerSellerOutput"}},"components/schemas/ConsignmentCommercialInvoiceExtraField":{"id":"components/schemas/ConsignmentCommercialInvoiceExtraField","kind":"json-schema","title":"ConsignmentCommercialInvoiceExtraField","data":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the commercial invoice"},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value","description":"Value of the commercial invoice"},"currency_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency Code","description":"Currency code of the commercial invoice"}},"type":"object","title":"ConsignmentCommercialInvoiceExtraField"}},"components/schemas/ConsignmentCustomsExportInfo":{"id":"components/schemas/ConsignmentCustomsExportInfo","kind":"json-schema","title":"ConsignmentCustomsExportInfo","data":{"properties":{"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"ISO 3166-1 alpha-2 country of the export declaration"},"declaration_type":{"anyOf":[{"$ref":"#/components/schemas/ExportDeclarationTypeEnum"},{"type":"null"}],"description":"Declaration type code (e.g. EU, EX)"},"additional_border_processes":{"anyOf":[{"items":{"$ref":"#/components/schemas/AdditionalExportBorderProcessEnum"},"type":"array"},{"type":"null"}],"title":"Additional Border Processes","description":"Additional border processes for this declaration"},"mrn":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mrn","description":"Movement Reference Number of the export declaration"},"exs_mrn":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Exs Mrn","description":"Exit Summary Declaration MRN"},"ducr":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ducr","description":"Declaration Unique Consignment Reference (UK only)"},"location_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Location Id","description":"Identifier of the customs location"},"emails":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Emails","description":"Email addresses associated with this declaration"}},"type":"object","title":"ConsignmentCustomsExportInfo"}},"components/schemas/ConsignmentCustomsImportInfo":{"id":"components/schemas/ConsignmentCustomsImportInfo","kind":"json-schema","title":"ConsignmentCustomsImportInfo","data":{"properties":{"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"ISO 3166-1 alpha-2 country of the import declaration"},"declaration_type":{"anyOf":[{"$ref":"#/components/schemas/ImportDeclarationTypeEnum"},{"type":"null"}],"description":"Declaration type code (e.g. IM)"},"additional_border_processes":{"anyOf":[{"items":{"$ref":"#/components/schemas/AdditionalImportBorderProcessEnum"},"type":"array"},{"type":"null"}],"title":"Additional Border Processes","description":"Additional border processes for this declaration"},"mrn":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mrn","description":"Movement Reference Number of the import declaration"},"ens_mrn":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ens Mrn","description":"Entry Summary Declaration MRN"},"ducr":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ducr","description":"Declaration Unique Consignment Reference (UK only)"},"temporary_storage_ucn":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Temporary Storage Ucn","description":"Temporary storage UCN"},"temporary_storage_crn":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Temporary Storage Crn","description":"Temporary storage CRN (BE only)"},"emails":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Emails","description":"Email addresses associated with this declaration"}},"type":"object","title":"ConsignmentCustomsImportInfo"}},"components/schemas/ConsignmentCustomsTransitInfoInput":{"id":"components/schemas/ConsignmentCustomsTransitInfoInput","kind":"json-schema","title":"ConsignmentCustomsTransitInfoInput","data":{"properties":{"sequence_number":{"type":"integer","title":"Sequence Number","description":"Identifier and ordering key for partial updates (required)"},"declaration_type":{"anyOf":[{"$ref":"#/components/schemas/TransitDeclarationTypeEnum"},{"type":"null"}],"description":"Declaration type code (e.g. T1, T2)"},"additional_border_processes":{"anyOf":[{"items":{"$ref":"#/components/schemas/AdditionalTransitBorderProcessEnum"},"type":"array"},{"type":"null"}],"title":"Additional Border Processes","description":"Additional border processes for this declaration"},"lrn":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lrn","description":"Local Reference Number"},"mrn":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mrn","description":"Movement Reference Number"},"start_office":{"anyOf":[{"$ref":"#/components/schemas/TransitOffice"},{"type":"null"}],"description":"Office of departure"},"end_office":{"anyOf":[{"$ref":"#/components/schemas/TransitOffice"},{"type":"null"}],"description":"Office of destination"},"valid_to_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Valid To Date","description":"Validity end date (ISO 8601)"},"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"Existing transit declaration identifier (for updates)"}},"type":"object","required":["sequence_number"],"title":"ConsignmentCustomsTransitInfoInput"}},"components/schemas/ConsignmentCustomsTransitInfoOutput":{"id":"components/schemas/ConsignmentCustomsTransitInfoOutput","kind":"json-schema","title":"ConsignmentCustomsTransitInfoOutput","data":{"properties":{"sequence_number":{"type":"integer","title":"Sequence Number","description":"Identifier and ordering key for partial updates (required)"},"declaration_type":{"anyOf":[{"$ref":"#/components/schemas/TransitDeclarationTypeEnum"},{"type":"null"}],"description":"Declaration type code (e.g. T1, T2)"},"additional_border_processes":{"anyOf":[{"items":{"$ref":"#/components/schemas/AdditionalTransitBorderProcessEnum"},"type":"array"},{"type":"null"}],"title":"Additional Border Processes","description":"Additional border processes for this declaration"},"lrn":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lrn","description":"Local Reference Number"},"mrn":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mrn","description":"Movement Reference Number"},"start_office":{"anyOf":[{"$ref":"#/components/schemas/TransitOffice"},{"type":"null"}],"description":"Office of departure"},"end_office":{"anyOf":[{"$ref":"#/components/schemas/TransitOffice"},{"type":"null"}],"description":"Office of destination"},"valid_to_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Valid To Date","description":"Validity end date (ISO 8601)"},"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier of the transit declaration"}},"type":"object","required":["sequence_number","id"],"title":"ConsignmentCustomsTransitInfoOutput"}},"components/schemas/ConsignmentData":{"id":"components/schemas/ConsignmentData","kind":"json-schema","title":"ConsignmentData","data":{"properties":{"pickup_stop":{"anyOf":[{"$ref":"#/components/schemas/StopData"},{"type":"null"}]},"delivery_stop":{"anyOf":[{"$ref":"#/components/schemas/StopData"},{"type":"null"}]},"consignment_reference_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Consignment Reference Number"},"cmr_reference_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cmr Reference Number"},"planning_instructions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Planning Instructions"},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Custom Fields"},"transport_network":{"anyOf":[{"$ref":"#/components/schemas/ConsignmentTransportNetwork"},{"type":"null"}]},"central_transport_network":{"anyOf":[{"$ref":"#/components/schemas/CentralTransportNetworkConsignmentInput"},{"type":"null"}]},"palletline":{"anyOf":[{"$ref":"#/components/schemas/PalletlineConsignmentInput"},{"type":"null"}]},"palletforce":{"anyOf":[{"$ref":"#/components/schemas/PalletforceConsignmentInput"},{"type":"null"}]},"palletxpress_ie":{"anyOf":[{"$ref":"#/components/schemas/PalletXpressIeConsignmentInput"},{"type":"null"}]},"tpn":{"anyOf":[{"$ref":"#/components/schemas/TPNConsignmentInput"},{"type":"null"}]},"pallet_track":{"anyOf":[{"$ref":"#/components/schemas/PalletTrackConsignmentInput"},{"type":"null"}]},"palletways":{"anyOf":[{"$ref":"#/components/schemas/PalletwaysConsignmentInput"},{"type":"null"}]},"project44":{"anyOf":[{"$ref":"#/components/schemas/Project44ConsignmentInput"},{"type":"null"}]},"hazchem":{"anyOf":[{"$ref":"#/components/schemas/HazchemConsignmentInput"},{"type":"null"}]},"transporeon":{"anyOf":[{"$ref":"#/components/schemas/TransporeonConsignmentExtraFields"},{"type":"null"}]},"import_export":{"anyOf":[{"$ref":"#/components/schemas/ConsignmentImportExportExtraFieldsInput-Input"},{"type":"null"}]},"goods":{"anyOf":[{"items":{"$ref":"#/components/schemas/GoodData"},"type":"array"},{"type":"null"}],"title":"Goods"},"standalone_stops":{"anyOf":[{"items":{"$ref":"#/components/schemas/StopData"},"type":"array"},{"type":"null"}],"title":"Standalone Stops"},"shipper_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Shipper Name"},"shipper_reference_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Shipper Reference Number"},"buyer":{"anyOf":[{"$ref":"#/components/schemas/BuyerSellerField"},{"type":"null"}]},"seller":{"anyOf":[{"$ref":"#/components/schemas/BuyerSellerField"},{"type":"null"}]},"buyer_eori_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Buyer Eori Number"},"seller_eori_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Seller Eori Number"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id"},"consignee_signature":{"anyOf":[{"$ref":"#/components/schemas/SignatureInput"},{"type":"null"}]},"consignor_signature":{"anyOf":[{"$ref":"#/components/schemas/SignatureInput"},{"type":"null"}]}},"type":"object","title":"ConsignmentData"}},"components/schemas/ConsignmentEntityUpdate":{"id":"components/schemas/ConsignmentEntityUpdate","kind":"json-schema","title":"ConsignmentEntityUpdate","data":{"properties":{"operation":{"$ref":"#/components/schemas/ConsignmentUpdateOperation"},"data":{"anyOf":[{"$ref":"#/components/schemas/ConsignmentUpdateData"},{"$ref":"#/components/schemas/ConsignmentData"},{"type":"null"}],"title":"Data"}},"type":"object","required":["operation"],"title":"ConsignmentEntityUpdate"}},"components/schemas/ConsignmentImportExportExtraFieldsInput-Input":{"id":"components/schemas/ConsignmentImportExportExtraFieldsInput-Input","kind":"json-schema","title":"ConsignmentImportExportExtraFieldsInput","data":{"properties":{"commercial_invoice":{"anyOf":[{"$ref":"#/components/schemas/ConsignmentCommercialInvoiceExtraField"},{"type":"null"}]},"export_declaration":{"anyOf":[{"$ref":"#/components/schemas/ConsignmentCustomsExportInfo"},{"type":"null"}]},"import_declaration":{"anyOf":[{"$ref":"#/components/schemas/ConsignmentCustomsImportInfo"},{"type":"null"}]},"transit_declarations":{"anyOf":[{"items":{"$ref":"#/components/schemas/ConsignmentCustomsTransitInfoInput"},"type":"array","maxItems":1},{"type":"null"}],"title":"Transit Declarations","description":"At most one transit declaration on input. (Multi-transit available via UI; the public API will lift this cap in a later release.)"}},"type":"object","title":"ConsignmentImportExportExtraFieldsInput"}},"components/schemas/ConsignmentImportExportExtraFieldsInput-Output":{"id":"components/schemas/ConsignmentImportExportExtraFieldsInput-Output","kind":"json-schema","title":"ConsignmentImportExportExtraFieldsInput","data":{"properties":{"commercial_invoice":{"anyOf":[{"$ref":"#/components/schemas/ConsignmentCommercialInvoiceExtraField"},{"type":"null"}]},"export_declaration":{"anyOf":[{"$ref":"#/components/schemas/ConsignmentCustomsExportInfo"},{"type":"null"}]},"import_declaration":{"anyOf":[{"$ref":"#/components/schemas/ConsignmentCustomsImportInfo"},{"type":"null"}]},"transit_declarations":{"anyOf":[{"items":{"$ref":"#/components/schemas/ConsignmentCustomsTransitInfoInput"},"type":"array","maxItems":1},{"type":"null"}],"title":"Transit Declarations","description":"At most one transit declaration on input. (Multi-transit available via UI; the public API will lift this cap in a later release.)"}},"type":"object","title":"ConsignmentImportExportExtraFieldsInput"}},"components/schemas/ConsignmentImportExportExtraFieldsOutput-Input":{"id":"components/schemas/ConsignmentImportExportExtraFieldsOutput-Input","kind":"json-schema","title":"ConsignmentImportExportExtraFieldsOutput","data":{"properties":{"commercial_invoice":{"anyOf":[{"$ref":"#/components/schemas/ConsignmentCommercialInvoiceExtraField"},{"type":"null"}]},"export_declaration":{"anyOf":[{"$ref":"#/components/schemas/ConsignmentCustomsExportInfo"},{"type":"null"}]},"import_declaration":{"anyOf":[{"$ref":"#/components/schemas/ConsignmentCustomsImportInfo"},{"type":"null"}]},"transit_declarations":{"anyOf":[{"items":{"$ref":"#/components/schemas/ConsignmentCustomsTransitInfoOutput"},"type":"array"},{"type":"null"}],"title":"Transit Declarations"}},"type":"object","title":"ConsignmentImportExportExtraFieldsOutput"}},"components/schemas/ConsignmentImportExportExtraFieldsOutput-Output":{"id":"components/schemas/ConsignmentImportExportExtraFieldsOutput-Output","kind":"json-schema","title":"ConsignmentImportExportExtraFieldsOutput","data":{"properties":{"commercial_invoice":{"anyOf":[{"$ref":"#/components/schemas/ConsignmentCommercialInvoiceExtraField"},{"type":"null"}]},"export_declaration":{"anyOf":[{"$ref":"#/components/schemas/ConsignmentCustomsExportInfo"},{"type":"null"}]},"import_declaration":{"anyOf":[{"$ref":"#/components/schemas/ConsignmentCustomsImportInfo"},{"type":"null"}]},"transit_declarations":{"anyOf":[{"items":{"$ref":"#/components/schemas/ConsignmentCustomsTransitInfoOutput"},"type":"array"},{"type":"null"}],"title":"Transit Declarations"}},"type":"object","title":"ConsignmentImportExportExtraFieldsOutput"}},"components/schemas/ConsignmentInput-Input":{"id":"components/schemas/ConsignmentInput-Input","kind":"json-schema","title":"ConsignmentInput","data":{"properties":{"consignment_reference_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Consignment Reference Number","description":"Consignment reference number"},"cmr_reference_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cmr Reference Number"},"planning_instructions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Planning Instructions","description":"Additional freeform instructions for the planner."},"custom_fields":{"type":"object","title":"Custom Fields","description":"Additional user defined fields to fill in"},"transport_network":{"anyOf":[{"$ref":"#/components/schemas/ConsignmentTransportNetwork"},{"type":"null"}],"description":"Transport network"},"central_transport_network":{"anyOf":[{"$ref":"#/components/schemas/CentralTransportNetworkConsignmentExtraFields"},{"type":"null"}]},"palletline":{"anyOf":[{"$ref":"#/components/schemas/PalletlineConsignmentExtraFields"},{"type":"null"}]},"palletforce":{"anyOf":[{"$ref":"#/components/schemas/PalletforceConsignmentExtraFields"},{"type":"null"}]},"transporeon":{"anyOf":[{"$ref":"#/components/schemas/TransporeonConsignmentExtraFields"},{"type":"null"}]},"pickup_stop":{"$ref":"#/components/schemas/StopInput-Input","description":"First stop on this consignment."},"delivery_stop":{"$ref":"#/components/schemas/StopInput-Input","description":"Last stop on this consignment."},"goods":{"anyOf":[{"items":{"$ref":"#/components/schemas/GoodInput-Input"},"type":"array"},{"type":"null"}],"title":"Goods"},"import_export":{"anyOf":[{"$ref":"#/components/schemas/ConsignmentImportExportExtraFieldsInput-Input"},{"type":"null"}]},"buyer":{"anyOf":[{"$ref":"#/components/schemas/Entity"},{"type":"null"}],"description":"Buyer information for this consignment"},"seller":{"anyOf":[{"$ref":"#/components/schemas/Entity"},{"type":"null"}],"description":"Seller information for this consignment"}},"type":"object","required":["pickup_stop","delivery_stop"],"title":"ConsignmentInput"}},"components/schemas/ConsignmentInput-Output":{"id":"components/schemas/ConsignmentInput-Output","kind":"json-schema","title":"ConsignmentInput","data":{"properties":{"consignment_reference_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Consignment Reference Number","description":"Consignment reference number"},"cmr_reference_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cmr Reference Number"},"planning_instructions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Planning Instructions","description":"Additional freeform instructions for the planner."},"custom_fields":{"type":"object","title":"Custom Fields","description":"Additional user defined fields to fill in"},"transport_network":{"anyOf":[{"$ref":"#/components/schemas/ConsignmentTransportNetwork"},{"type":"null"}],"description":"Transport network"},"central_transport_network":{"anyOf":[{"$ref":"#/components/schemas/CentralTransportNetworkConsignmentExtraFields"},{"type":"null"}]},"palletline":{"anyOf":[{"$ref":"#/components/schemas/PalletlineConsignmentExtraFields"},{"type":"null"}]},"palletforce":{"anyOf":[{"$ref":"#/components/schemas/PalletforceConsignmentExtraFields"},{"type":"null"}]},"transporeon":{"anyOf":[{"$ref":"#/components/schemas/TransporeonConsignmentExtraFields"},{"type":"null"}]},"pickup_stop":{"$ref":"#/components/schemas/StopInput-Output","description":"First stop on this consignment."},"delivery_stop":{"$ref":"#/components/schemas/StopInput-Output","description":"Last stop on this consignment."},"goods":{"anyOf":[{"items":{"$ref":"#/components/schemas/GoodInput-Output"},"type":"array"},{"type":"null"}],"title":"Goods"},"import_export":{"anyOf":[{"$ref":"#/components/schemas/ConsignmentImportExportExtraFieldsInput-Output"},{"type":"null"}]},"buyer":{"anyOf":[{"$ref":"#/components/schemas/Entity"},{"type":"null"}],"description":"Buyer information for this consignment"},"seller":{"anyOf":[{"$ref":"#/components/schemas/Entity"},{"type":"null"}],"description":"Seller information for this consignment"}},"type":"object","required":["pickup_stop","delivery_stop"],"title":"ConsignmentInput"}},"components/schemas/ConsignmentMatch":{"id":"components/schemas/ConsignmentMatch","kind":"json-schema","title":"ConsignmentMatch","data":{"properties":{"reference_number":{"anyOf":[{"$ref":"#/components/schemas/FieldMatchInput"},{"type":"null"}]},"order_sequence_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Order Sequence Number"}},"type":"object","title":"ConsignmentMatch"}},"components/schemas/ConsignmentOutput-Input":{"id":"components/schemas/ConsignmentOutput-Input","kind":"json-schema","title":"ConsignmentOutput","data":{"properties":{"consignment_reference_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Consignment Reference Number","description":"Consignment reference number"},"cmr_reference_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cmr Reference Number"},"planning_instructions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Planning Instructions","description":"Additional freeform instructions for the planner."},"custom_fields":{"type":"object","title":"Custom Fields","description":"Additional user defined fields to fill in"},"transport_network":{"anyOf":[{"$ref":"#/components/schemas/ConsignmentTransportNetwork"},{"type":"null"}],"description":"Transport network"},"central_transport_network":{"anyOf":[{"$ref":"#/components/schemas/CentralTransportNetworkConsignmentExtraFields"},{"type":"null"}]},"palletline":{"anyOf":[{"$ref":"#/components/schemas/PalletlineConsignmentExtraFields"},{"type":"null"}]},"palletforce":{"anyOf":[{"$ref":"#/components/schemas/PalletforceConsignmentExtraFields"},{"type":"null"}]},"transporeon":{"anyOf":[{"$ref":"#/components/schemas/TransporeonConsignmentExtraFields"},{"type":"null"}]},"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier of the consignment"},"pickup_stop":{"$ref":"#/components/schemas/StopOutput-Input","description":"First stop on this consignment."},"delivery_stop":{"$ref":"#/components/schemas/StopOutput-Input","description":"Last stop on this consignment."},"goods":{"anyOf":[{"items":{"$ref":"#/components/schemas/GoodOutput-Input"},"type":"array"},{"type":"null"}],"title":"Goods"},"signatures":{"items":{"$ref":"#/components/schemas/Signature"},"type":"array","title":"Signatures","description":"List of signatures related to the consignment"},"import_export":{"anyOf":[{"$ref":"#/components/schemas/ConsignmentImportExportExtraFieldsOutput-Input"},{"type":"null"}]},"buyer":{"anyOf":[{"$ref":"#/components/schemas/ConsignmentBuyerSellerOutput-Input"},{"type":"null"}],"description":"Buyer information for this consignment"},"seller":{"anyOf":[{"$ref":"#/components/schemas/ConsignmentBuyerSellerOutput-Input"},{"type":"null"}],"description":"Seller information for this consignment"}},"type":"object","required":["id","pickup_stop","delivery_stop"],"title":"ConsignmentOutput"}},"components/schemas/ConsignmentOutput-Output":{"id":"components/schemas/ConsignmentOutput-Output","kind":"json-schema","title":"ConsignmentOutput","data":{"properties":{"consignment_reference_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Consignment Reference Number","description":"Consignment reference number"},"cmr_reference_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cmr Reference Number"},"planning_instructions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Planning Instructions","description":"Additional freeform instructions for the planner."},"custom_fields":{"type":"object","title":"Custom Fields","description":"Additional user defined fields to fill in"},"transport_network":{"anyOf":[{"$ref":"#/components/schemas/ConsignmentTransportNetwork"},{"type":"null"}],"description":"Transport network"},"central_transport_network":{"anyOf":[{"$ref":"#/components/schemas/CentralTransportNetworkConsignmentExtraFields"},{"type":"null"}]},"palletline":{"anyOf":[{"$ref":"#/components/schemas/PalletlineConsignmentExtraFields"},{"type":"null"}]},"palletforce":{"anyOf":[{"$ref":"#/components/schemas/PalletforceConsignmentExtraFields"},{"type":"null"}]},"transporeon":{"anyOf":[{"$ref":"#/components/schemas/TransporeonConsignmentExtraFields"},{"type":"null"}]},"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier of the consignment"},"pickup_stop":{"$ref":"#/components/schemas/StopOutput-Output","description":"First stop on this consignment."},"delivery_stop":{"$ref":"#/components/schemas/StopOutput-Output","description":"Last stop on this consignment."},"goods":{"anyOf":[{"items":{"$ref":"#/components/schemas/GoodOutput-Output"},"type":"array"},{"type":"null"}],"title":"Goods"},"signatures":{"items":{"$ref":"#/components/schemas/Signature"},"type":"array","title":"Signatures","description":"List of signatures related to the consignment"},"import_export":{"anyOf":[{"$ref":"#/components/schemas/ConsignmentImportExportExtraFieldsOutput-Output"},{"type":"null"}]},"buyer":{"anyOf":[{"$ref":"#/components/schemas/ConsignmentBuyerSellerOutput-Output"},{"type":"null"}],"description":"Buyer information for this consignment"},"seller":{"anyOf":[{"$ref":"#/components/schemas/ConsignmentBuyerSellerOutput-Output"},{"type":"null"}],"description":"Seller information for this consignment"}},"type":"object","required":["id","pickup_stop","delivery_stop"],"title":"ConsignmentOutput"}},"components/schemas/ConsignmentTransportNetwork":{"id":"components/schemas/ConsignmentTransportNetwork","kind":"json-schema","title":"ConsignmentTransportNetwork","data":{"properties":{"requesting_depot_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Requesting Depot Code","description":"Depot code of the requesting depot"},"collection_depot_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Collection Depot Code","description":"Depot code of the collection depot"},"delivery_depot_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Delivery Depot Code","description":"Depot code of the delivery depot"}},"type":"object","title":"ConsignmentTransportNetwork"}},"components/schemas/ConsignmentUpdateData":{"id":"components/schemas/ConsignmentUpdateData","kind":"json-schema","title":"ConsignmentUpdateData","data":{"properties":{"consignment_reference_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Consignment Reference Number"},"cmr_reference_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cmr Reference Number"},"planning_instructions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Planning Instructions"},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Custom Fields"},"transport_network":{"anyOf":[{"$ref":"#/components/schemas/ConsignmentTransportNetwork"},{"type":"null"}]},"central_transport_network":{"anyOf":[{"$ref":"#/components/schemas/CentralTransportNetworkConsignmentInput"},{"type":"null"}]},"palletline":{"anyOf":[{"$ref":"#/components/schemas/PalletlineConsignmentInput"},{"type":"null"}]},"palletforce":{"anyOf":[{"$ref":"#/components/schemas/PalletforceConsignmentInput"},{"type":"null"}]},"palletxpress_ie":{"anyOf":[{"$ref":"#/components/schemas/PalletXpressIeConsignmentInput"},{"type":"null"}]},"tpn":{"anyOf":[{"$ref":"#/components/schemas/TPNConsignmentInput"},{"type":"null"}]},"pallet_track":{"anyOf":[{"$ref":"#/components/schemas/PalletTrackConsignmentInput"},{"type":"null"}]},"palletways":{"anyOf":[{"$ref":"#/components/schemas/PalletwaysConsignmentInput"},{"type":"null"}]},"project44":{"anyOf":[{"$ref":"#/components/schemas/Project44ConsignmentInput"},{"type":"null"}]},"hazchem":{"anyOf":[{"$ref":"#/components/schemas/HazchemConsignmentInput"},{"type":"null"}]},"transporeon":{"anyOf":[{"$ref":"#/components/schemas/TransporeonConsignmentExtraFields"},{"type":"null"}]},"import_export":{"anyOf":[{"$ref":"#/components/schemas/ConsignmentImportExportExtraFieldsInput-Input"},{"type":"null"}]},"shipper_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Shipper Name"},"shipper_reference_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Shipper Reference Number"},"buyer_eori_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Buyer Eori Number"},"seller_eori_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Seller Eori Number"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id"},"consignee_signature":{"anyOf":[{"$ref":"#/components/schemas/SignatureInput"},{"type":"null"}]},"consignor_signature":{"anyOf":[{"$ref":"#/components/schemas/SignatureInput"},{"type":"null"}]}},"type":"object","title":"ConsignmentUpdateData"}},"components/schemas/ConsignmentUpdateOperation":{"id":"components/schemas/ConsignmentUpdateOperation","kind":"json-schema","title":"ConsignmentUpdateOperation","data":{"type":"string","enum":["CREATE","UPDATE","DELETE","CANCEL","UNCANCEL"],"title":"ConsignmentUpdateOperation","description":"Operation type for partial consignment structural updates.\n\nConsignments additionally support CANCEL / UNCANCEL, which move the consignment between\nCANCELLED and a plannable state while keeping the record. They are not valid on any other\nentity, so they live here instead of on UpdateOperation."}},"components/schemas/ContactType":{"id":"components/schemas/ContactType","kind":"json-schema","title":"ContactType","data":{"type":"string","enum":["BILLING","OPERATIONS","BOOKINGS","NOTIFICATIONS","CLEANING","HEATING","STORAGE","CONTAINER_RELEASE","DRIVER","OTHER","CMR_PROCESSING","PAYMENT_REMINDERS","CLAIMS_INSURANCE","CUSTOMS","IT","QUALITY","SALES","CUSTOMER_CONTACT"],"title":"ContactType"}},"components/schemas/Container":{"id":"components/schemas/Container","kind":"json-schema","title":"Container","data":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"ID of the resource"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the resource"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code of the resource"},"is_archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Archived","description":"Is the resource archived"},"is_external_resource":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is External Resource","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Read-only. True if this is a non-owned (subcontractor) resource. When this resource appears inside a trip, name / license_plate / container_number reflect the per-trip override value if one was set on the resource allocation; otherwise the resource master value is returned. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the value is not yet projected — treat as internal for backwards compatibility."},"children":[]}]}]}],"examples":[true]},"custom_fields":{"type":"object","title":"Custom Fields","description":"Store values for user defined fields"},"subcontractor":{"anyOf":[{"$ref":"#/components/schemas/CompanyOutput-Input"},{"type":"null"}],"description":"Subcontractor linked to the resource"},"resource_type":{"anyOf":[{"$ref":"#/components/schemas/ResourceTypeEnum"},{"type":"null"}],"description":"Type of the resource"},"container_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Container Number","description":"Container number"},"manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Manufacturer","description":"Manufacturer of the container"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"Note about the container"},"standard_size":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Standard Size","description":"Standard size of the container"},"iso_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Iso Code","description":"ISO 6346 container type code (e.g. '22G1', '45G1')"}},"type":"object","title":"Container"}},"components/schemas/ContainerDocumentTypes":{"id":"components/schemas/ContainerDocumentTypes","kind":"json-schema","title":"ContainerDocumentTypes","data":{"type":"string","enum":["COMMUNICATION_SUBCONTRACTOR","CONTAINER_CERTIFICATE","CONTAINER_DAMAGE_REPORT","CONTAINER_INSPECTION_REPORT","CONTAINER_LEASE","CONTAINER_MAINTENANCE_REPORT","CONTAINER_REPAIR_REPORT","CONTAINER_TANK_TEST_CERTIFICATE_2Y5","CONTAINER_TANK_TEST_CERTIFICATE_5Y","CONTAINER_TANK_TEST_CERTIFICATE"],"title":"ContainerDocumentTypes"}},"components/schemas/ContainerExtraFields":{"id":"components/schemas/ContainerExtraFields","kind":"json-schema","title":"ContainerExtraFields","data":{"properties":{"seal_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Seal Number","description":"Container seal number"},"port_of_loading":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Port Of Loading","description":"Port of loading"},"port_of_unloading":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Port Of Unloading","description":"Port of unloading"},"origin_of_goods":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Origin Of Goods","description":"Origin of goods"},"unique_consignment_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unique Consignment Number","description":"Unique consignment number"},"ocean_liner_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ocean Liner Name","description":"Ocean liner name"},"ocean_liner_scac":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ocean Liner Scac","description":"Ocean liner SCAC"},"pin_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pin Code","description":"PIN code"},"ship_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ship Name","description":"Ship name"},"closing_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Closing Date","description":"Closing date"},"tare_weight":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Tare Weight","description":"Tare weight"},"container_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Container Number","description":"Number of the container"},"container_type":{"anyOf":[{"$ref":"#/components/schemas/ContainerType"},{"type":"null"}],"description":"Type of the container"},"container_scenario":{"anyOf":[{"$ref":"#/components/schemas/ContainerScenario"},{"type":"null"}],"description":"Scenario of the container"},"secure_release":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Secure Release","description":"Is secure release enabled"}},"type":"object","title":"ContainerExtraFields"}},"components/schemas/ContainerMatchInput":{"id":"components/schemas/ContainerMatchInput","kind":"json-schema","title":"ContainerMatchInput","data":{"properties":{"name":{"anyOf":[{"$ref":"#/components/schemas/FieldMatchInput"},{"type":"null"}]},"generic_id":{"anyOf":[{"$ref":"#/components/schemas/FieldMatchInput"},{"type":"null"}]},"integration_object_id":{"anyOf":[{"$ref":"#/components/schemas/FieldMatchInput"},{"type":"null"}],"description":"The resource ID in the given context of your integration. "}},"type":"object","title":"ContainerMatchInput","example":{"generic_id":{"matches_any":["CONT-001"]}}}},"components/schemas/ContainerOrderInput":{"id":"components/schemas/ContainerOrderInput","kind":"json-schema","title":"ContainerOrderInput","data":{"properties":{"seal_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Seal Number"},"port_of_loading":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Port Of Loading"},"port_of_unloading":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Port Of Unloading"},"origin_of_goods":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Origin Of Goods"},"unique_consignment_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unique Consignment Number"},"ocean_liner_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ocean Liner Name"},"ocean_liner_scac":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ocean Liner Scac"},"pin_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pin Code"},"ship_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ship Name"},"closing_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Closing Date"},"tare_weight":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Tare Weight"},"container_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Container Number"},"container_type":{"anyOf":[{"$ref":"#/components/schemas/ContainerTypeInput"},{"type":"null"}]},"container_scenario":{"anyOf":[{"$ref":"#/components/schemas/ContainerScenario"},{"type":"null"}]},"secure_release":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Secure Release"}},"type":"object","title":"ContainerOrderInput"}},"components/schemas/ContainerProperties":{"id":"components/schemas/ContainerProperties","kind":"json-schema","title":"ContainerProperties","data":{"properties":{"container_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Container Number","description":"Container number"},"manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Manufacturer","description":"Manufacturer of the container"},"standard_size":{"anyOf":[{"type":"string","enum":["FEET_20","FEET_23","FEET_24","FEET_25","FEET_26","FEET_30","FEET_35","FEET_40","FEET_45"]},{"type":"null"}],"title":"Standard Size","description":"Standard size of the container"},"iso_code":{"anyOf":[{"type":"string","maxLength":4},{"type":"null"}],"title":"Iso Code","description":"ISO 6346 container type code (e.g. '22G1', '45G1')"}},"type":"object","title":"ContainerProperties"}},"components/schemas/ContainerResource-Input":{"id":"components/schemas/ContainerResource-Input","kind":"json-schema","title":"ContainerResource","data":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"ID of the resource"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the resource"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code of the resource"},"is_archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Archived","description":"Is the resource archived"},"is_external_resource":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is External Resource","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Read-only. True if this is a non-owned (subcontractor) resource. When this resource appears inside a trip, name / license_plate / container_number reflect the per-trip override value if one was set on the resource allocation; otherwise the resource master value is returned. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the value is not yet projected — treat as internal for backwards compatibility."},"children":[]}]}]}],"examples":[true]},"custom_fields":{"type":"object","title":"Custom Fields","description":"Store values for user defined fields"},"subcontractor":{"anyOf":[{"$ref":"#/components/schemas/CompanyOutput-Input"},{"type":"null"}],"description":"Subcontractor linked to the resource"},"resource_type":{"anyOf":[{"$ref":"#/components/schemas/ResourceTypeEnum"},{"type":"null"}],"description":"Type of the resource"},"container_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Container Number","description":"Container number"},"manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Manufacturer","description":"Manufacturer of the container"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"Note about the container"},"standard_size":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Standard Size","description":"Standard size of the container"},"iso_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Iso Code","description":"ISO 6346 container type code (e.g. '22G1', '45G1')"}},"type":"object","title":"ContainerResource"}},"components/schemas/ContainerResource-Output":{"id":"components/schemas/ContainerResource-Output","kind":"json-schema","title":"ContainerResource","data":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"ID of the resource"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the resource"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code of the resource"},"is_archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Archived","description":"Is the resource archived"},"is_external_resource":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is External Resource","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Read-only. True if this is a non-owned (subcontractor) resource. When this resource appears inside a trip, name / license_plate / container_number reflect the per-trip override value if one was set on the resource allocation; otherwise the resource master value is returned. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the value is not yet projected — treat as internal for backwards compatibility."},"children":[]}]}]}],"examples":[true]},"custom_fields":{"type":"object","title":"Custom Fields","description":"Store values for user defined fields"},"subcontractor":{"anyOf":[{"$ref":"#/components/schemas/CompanyOutput-Output"},{"type":"null"}],"description":"Subcontractor linked to the resource"},"resource_type":{"anyOf":[{"$ref":"#/components/schemas/ResourceTypeEnum"},{"type":"null"}],"description":"Type of the resource"},"container_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Container Number","description":"Container number"},"manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Manufacturer","description":"Manufacturer of the container"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"Note about the container"},"standard_size":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Standard Size","description":"Standard size of the container"},"iso_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Iso Code","description":"ISO 6346 container type code (e.g. '22G1', '45G1')"}},"type":"object","title":"ContainerResource"}},"components/schemas/ContainerResourceInput":{"id":"components/schemas/ContainerResourceInput","kind":"json-schema","title":"ContainerResourceInput","data":{"properties":{"is_archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Archived","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reactivate a previously archived resource, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to archive it. Only takes effect when included in the request; omit it to leave the archive state unchanged."},"children":[]}]}]}]},"billing_entity":{"anyOf":[{"$ref":"#/components/schemas/BillingEntityReference"},{"type":"null"}],"description":"Billing entity associated with the resource, defaults to default billing entity if not provided"},"extras":{"anyOf":[{"items":{"$ref":"#/components/schemas/ResourceExtraInput"},"type":"array"},{"type":"null"}],"title":"Extras","description":"Stop extras this resource is compatible with. Replaces the existing list when provided. Send an empty list to clear all compatible extras."},"name":{"type":"string","title":"Name","description":"Name of the resource"},"external_id":{"type":"string","title":"External Id","description":"External identifier of the resource","default":""},"locale":{"anyOf":[{"type":"string","pattern":"^[a-z]{2}(-[A-Z]{2})?$"},{"type":"null"}],"title":"Locale","description":"Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.","examples":["en","nl","en-GB","fr-BE"]},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code of the resource"},"note":{"type":"string","title":"Note","description":"Note about the resource","default":""},"custom_fields":{"type":"object","title":"Custom Fields","description":"User defined additional fields for this resource"},"subcontractor":{"anyOf":[{"$ref":"#/components/schemas/CompanyReference"},{"type":"null"}],"description":"Company linked to the resource"},"integrations":{"anyOf":[{"additionalProperties":{"type":"object"},"type":"object"},{"type":"null"}],"title":"Integrations","description":"Related integrations for the resource. The key is the unique code of the integration in Qargo","examples":[{"addsecure1234":{"active":true,"object_id":"1234"}}]},"container":{"anyOf":[{"$ref":"#/components/schemas/ContainerProperties"},{"type":"null"}],"description":"Container specific properties"}},"type":"object","required":["name"],"title":"ContainerResourceInput"}},"components/schemas/ContainerResourceOutput":{"id":"components/schemas/ContainerResourceOutput","kind":"json-schema","title":"ContainerResourceOutput","data":{"properties":{"row_id":{"type":"string","format":"uuid","title":"Row Id","description":"Identifier of the reference"},"name":{"type":"string","title":"Name","description":"Name of the resource"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":"External identifier of the resource"},"locale":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Locale","description":"Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.","examples":["en","nl","en-GB","fr-BE"]},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code of the resource"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"Note about the resource"},"custom_fields":{"type":"object","title":"Custom Fields","description":"User defined additional fields for this resource"},"subcontractor":{"anyOf":[{"$ref":"#/components/schemas/CompanyReference"},{"type":"null"}],"description":"Company linked to the resource"},"integrations":{"anyOf":[{"additionalProperties":{"type":"object"},"type":"object"},{"type":"null"}],"title":"Integrations","description":"Related integrations for the resource. The key is the unique code of the integration in Qargo","examples":[{"addsecure1234":{"active":true,"object_id":"1234"}}]},"billing_entity":{"anyOf":[{"$ref":"#/components/schemas/BillingEntity"},{"type":"null"}],"description":"Billing entity associated with the resource"},"extras":{"items":{"$ref":"#/components/schemas/ResourceExtraOutput"},"type":"array","title":"Extras","description":"Stop extras this resource is compatible with"},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Active","description":"Is the resource active"},"is_external_resource":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is External Resource","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Read-only. True if this is a non-owned (subcontractor) resource. When this resource appears inside a trip, name / license_plate / container_number reflect the per-trip override value if one was set on the resource allocation; otherwise the resource master value is returned. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the value is not yet projected — treat as internal for backwards compatibility."},"children":[]}]}]}],"examples":[true]},"timestamp_updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp Updated","description":"Timestamp of the last update of the resource"},"resource_groups":{"items":{"$ref":"#/components/schemas/ResourceGroupOutput"},"type":"array","title":"Resource Groups","description":"Resource groups this resource currently belongs to (deduplicated and sorted by name). A resource can belong to more than one group. Active allocations are included regardless of their validity window (scheduled, future, or expired); archived allocations are excluded."},"container":{"anyOf":[{"$ref":"#/components/schemas/ContainerProperties"},{"type":"null"}],"description":"Container specific properties"}},"type":"object","required":["row_id","name"],"title":"ContainerResourceOutput"}},"components/schemas/ContainerScenario":{"id":"components/schemas/ContainerScenario","kind":"json-schema","title":"ContainerScenario","data":{"type":"string","enum":["IMPORT","EXPORT"],"title":"ContainerScenario"}},"components/schemas/ContainerType":{"id":"components/schemas/ContainerType","kind":"json-schema","title":"ContainerType","data":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Human readable identifier"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Machine readable identifier"},"custom_fields":{"type":"object","title":"Custom Fields","description":"Store values for user defined fields"},"container_iso_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Container Iso Code","description":"International standard ISO code identifying the container size and type (e.g. '22G1', '42G1')"}},"type":"object","title":"ContainerType"}},"components/schemas/ContainerTypeInput":{"id":"components/schemas/ContainerTypeInput","kind":"json-schema","title":"ContainerTypeInput","data":{"properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Custom Fields"}},"type":"object","title":"ContainerTypeInput"}},"components/schemas/CreditNoteStatus":{"id":"components/schemas/CreditNoteStatus","kind":"json-schema","title":"CreditNoteStatus","data":{"type":"string","enum":["DRAFT","PRE_INVOICED","INVOICED","POSTED"],"title":"CreditNoteStatus","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status description:"},"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":"DRAFT: Credit note is in draft state and not yet credited."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PRE_INVOICED: Credit note is in pre-invoiced state and not yet credited (Purchase credit note only)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INVOICED: Credit note is credited but not yet posted."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POSTED: Credit note is credited and posted."},"children":[]}]}]}]}]}},"components/schemas/CreditPolicyInput":{"id":"components/schemas/CreditPolicyInput","kind":"json-schema","title":"CreditPolicyInput","data":{"properties":{"limit":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Limit","description":"The limit for total amount that has been invoiced but not paid.","examples":[10000]}},"type":"object","title":"CreditPolicyInput"}},"components/schemas/CreditPolicyOutput":{"id":"components/schemas/CreditPolicyOutput","kind":"json-schema","title":"CreditPolicyOutput","data":{"properties":{"limit":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Limit","description":"The limit for total amount that has been invoiced but not paid.","examples":[10000]}},"type":"object","title":"CreditPolicyOutput"}},"components/schemas/CurrencyCode":{"id":"components/schemas/CurrencyCode","kind":"json-schema","title":"CurrencyCode","data":{"type":"string","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","FOK","GBP","GEL","GGP","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","IMP","INR","IQD","IRR","ISK","JEP","JMD","JOD","JPY","KES","KGS","KHR","KID","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TVD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"title":"CurrencyCode"}},"components/schemas/Customer":{"id":"components/schemas/Customer","kind":"json-schema","title":"Customer","data":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"ID of the customer"}},"type":"object","title":"Customer"}},"components/schemas/CustomerDocumentTypeInput":{"id":"components/schemas/CustomerDocumentTypeInput","kind":"json-schema","title":"CustomerDocumentTypeInput","data":{"type":"string","enum":["AUTHORIZATION_PREFERENTIAL_ORIGIN","BANK_DETAILS","CMR_INSURANCE","COMMUNICATION","COMPANY_TDS","CREDIT_REPORT","DGSA_CERTIFICATE","ECMT_TRANSPORT_LICENSE","EU_TRANSPORT_LICENSE","FREIGHT_FORWARDER_LICENSE","INSURANCE_3RD_PARTY_TRAILER","MEETING_SUMMARY","NATIONAL_TRANSPORT_LICENSE","OTHER","QUESTIONNAIRE_CUSTOMER","QUESTIONNAIRE_SUBCONTRACTOR","SERVICE_LEVEL_AGREEMENT","SQAS_CERTIFICATE","TRAILER_CLEANING_CERTIFICATE","VAT_VIES_VALIDATION","WASTE_PERMIT_GREEN_EU","WASTE_PERMIT_ORANGE_EU","WASTE_PERMIT_ORANGE_GREEN_EU"],"title":"CustomerDocumentTypeInput"}},"components/schemas/CustomerField":{"id":"components/schemas/CustomerField","kind":"json-schema","title":"CustomerField","data":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"row_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Row Id"}},"type":"object","title":"CustomerField"}},"components/schemas/CustomerReference":{"id":"components/schemas/CustomerReference","kind":"json-schema","title":"CustomerReference","data":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"The unique Qargo ID of the customer. Use this to distinguish between different customers sharing the same accounting code."},"accounting_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Accounting Code","description":"Accounting code that uniquely identifies the customer in the accounting system."}},"type":"object","title":"CustomerReference"}},"components/schemas/CustomerStatus":{"id":"components/schemas/CustomerStatus","kind":"json-schema","title":"CustomerStatus","data":{"type":"string","enum":["PROSPECT","NOT_APPROVED","APPROVED","WARNING","BLOCKED"],"title":"CustomerStatus"}},"components/schemas/Customs":{"id":"components/schemas/Customs","kind":"json-schema","title":"Customs","data":{"properties":{"pre_boarding_notification":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pre Boarding Notification","description":"Pre-Boarding Notification (PBN) reference."},"has_customs_territory_crossing":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Has Customs Territory Crossing","description":"Whether the intermodal leg crosses a customs territory boundary"}},"type":"object","title":"Customs"}},"components/schemas/CustomsMetadata":{"id":"components/schemas/CustomsMetadata","kind":"json-schema","title":"CustomsMetadata","data":{"properties":{"customs_office_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customs Office Code"}},"type":"object","title":"CustomsMetadata"}},"components/schemas/DachserExtraFields":{"id":"components/schemas/DachserExtraFields","kind":"json-schema","title":"DachserExtraFields","data":{"properties":{"consolidator_reference_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Consolidator Reference Number","description":"Consolidator reference number"}},"type":"object","title":"DachserExtraFields"}},"components/schemas/DaySchedule":{"id":"components/schemas/DaySchedule","kind":"json-schema","title":"DaySchedule","data":{"properties":{"enabled":{"type":"boolean","title":"Enabled","description":"Whether the location is open on this day.","default":false},"intervals":{"anyOf":[{"items":{"$ref":"#/components/schemas/TimeInterval"},"type":"array"},{"type":"null"}],"title":"Intervals","description":"Opening intervals for the day. Multiple intervals allow for split opening hours."}},"type":"object","title":"DaySchedule"}},"components/schemas/DayScheduleInput":{"id":"components/schemas/DayScheduleInput","kind":"json-schema","title":"DayScheduleInput","data":{"properties":{"enabled":{"type":"boolean","title":"Enabled","description":"Whether the location is open on this day."},"intervals":{"items":{"$ref":"#/components/schemas/TimeIntervalInput"},"type":"array","title":"Intervals","description":"Opening intervals for the day. Multiple intervals allow for split opening hours."}},"type":"object","required":["enabled"],"title":"DayScheduleInput"}},"components/schemas/Department":{"id":"components/schemas/Department","kind":"json-schema","title":"Department","data":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the department"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code of the department"}},"type":"object","title":"Department"}},"components/schemas/DispatchExecution":{"id":"components/schemas/DispatchExecution","kind":"json-schema","title":"DispatchExecution","data":{"properties":{"external_id":{"type":"string","title":"External Id","description":"ID in external system"}},"type":"object","required":["external_id"],"title":"DispatchExecution"}},"components/schemas/DispatchOperation":{"id":"components/schemas/DispatchOperation","kind":"json-schema","title":"DispatchOperation","data":{"type":"string","enum":["CREATE","UPDATE","CANCEL"],"title":"DispatchOperation"}},"components/schemas/DispatchOrder":{"id":"components/schemas/DispatchOrder","kind":"json-schema","title":"DispatchOrder","data":{"properties":{"transport_service":{"anyOf":[{"$ref":"#/components/schemas/Entity"},{"type":"null"}],"title":"Transport service","description":"Transport service within Qargo"},"customer_reference_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Order reference number from customer"},"service_level":{"anyOf":[{"$ref":"#/components/schemas/ServiceLevel"},{"type":"null"}]},"planning_instructions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Planning Instructions","description":"Additional freeform instructions for the planner."},"department":{"anyOf":[{"$ref":"#/components/schemas/Department"},{"type":"null"}],"description":"Department linked to order"},"neutral_order_type":{"anyOf":[{"type":"string","enum":["NO_NEUTRAL_ORDER","MASK_DELIVERY","MASK_PICKUP"]},{"type":"null"}],"title":"Neutral Order Type","description":"Neutral order"},"container":{"anyOf":[{"$ref":"#/components/schemas/ContainerExtraFields"},{"type":"null"}]},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"User defined additional fields for this order."},"vehicle_category":{"anyOf":[{"$ref":"#/components/schemas/VehicleCategory"},{"type":"null"}],"title":"Vehicle category"},"palletforce":{"anyOf":[{"$ref":"#/components/schemas/PalletforceExtraFields"},{"type":"null"}],"title":"Palletforce specific fields"},"kuehne_nagel":{"anyOf":[{"$ref":"#/components/schemas/KuehneNagelExtraFields"},{"type":"null"}],"title":"Kuehn Nagel specific fields"},"palletline":{"anyOf":[{"$ref":"#/components/schemas/PalletlineExtraFields"},{"type":"null"}],"title":"Palletline specific fields"},"transporeon":{"anyOf":[{"$ref":"#/components/schemas/TransporeonOrderExtraFields"},{"type":"null"}],"title":"Transporeon specific fields"},"dachser":{"anyOf":[{"$ref":"#/components/schemas/DachserExtraFields"},{"type":"null"}],"title":"Dachser specific fields"},"contact_emails":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Contact Emails","description":"List of contact emails to notify about the order"},"import_export":{"anyOf":[{"$ref":"#/components/schemas/ImportExportExtraFields"},{"type":"null"}],"title":"Fields specific to import and export"},"is_consignment_info_validated":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Consignment Info Validated","description":"Flag indicating all consignment information is validated. Customers can only set this to true; only planners (or API/internal callers) can revert it."},"stops":{"anyOf":[{"items":{"$ref":"#/components/schemas/StopOutput-Input"},"type":"array"},{"type":"null"}],"title":"Stops","description":"List of stops in the order, ordered by their sequence"},"order_identifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Order Identifier","description":"Identifier of the order when created from an external source"},"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier for order"},"consignments":{"items":{"$ref":"#/components/schemas/ConsignmentOutput-Input"},"type":"array","title":"Consignments"},"pricing":{"anyOf":[{"$ref":"#/components/schemas/OrderPricingOutput"},{"type":"null"}],"description":"Pricing fields related to order"},"customer":{"anyOf":[{"$ref":"#/components/schemas/CompanyOutput-Input"},{"type":"null"}],"title":"Customer"},"created_by_user":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By User","description":"User who created the order"},"created_timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created Timestamp","description":"Timestamp of creation"},"start_stop":{"anyOf":[{"$ref":"#/components/schemas/StopOutput-Input"},{"type":"null"}],"description":"First stop on this order"},"end_stop":{"anyOf":[{"$ref":"#/components/schemas/StopOutput-Input"},{"type":"null"}],"description":"Last stop on this order"},"quote_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quote Name","description":"Name of the quote"},"name":{"type":"string","title":"Name","description":"Name of the order"},"container_load_unload_stop":{"anyOf":[{"$ref":"#/components/schemas/StopOutput-Input"},{"type":"null"}],"title":"Container load/unload stop","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field practically maps to the container yard. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"setup_stops"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (for pick-up) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"teardown_stops"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (for drop-off) are replacing this field, please use them instead."},"children":[]}]}]}],"deprecated":true}},"type":"object","required":["id","consignments","name"],"title":"DispatchOrder"}},"components/schemas/DispatchOrderOutput":{"id":"components/schemas/DispatchOrderOutput","kind":"json-schema","title":"DispatchOrderOutput","data":{"properties":{"transport_service":{"anyOf":[{"$ref":"#/components/schemas/Entity"},{"type":"null"}],"title":"Transport service","description":"Transport service within Qargo"},"customer_reference_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Order reference number from customer"},"service_level":{"anyOf":[{"$ref":"#/components/schemas/ServiceLevel"},{"type":"null"}]},"planning_instructions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Planning Instructions","description":"Additional freeform instructions for the planner."},"department":{"anyOf":[{"$ref":"#/components/schemas/Department"},{"type":"null"}],"description":"Department linked to order"},"neutral_order_type":{"anyOf":[{"type":"string","enum":["NO_NEUTRAL_ORDER","MASK_DELIVERY","MASK_PICKUP"]},{"type":"null"}],"title":"Neutral Order Type","description":"Neutral order"},"container":{"anyOf":[{"$ref":"#/components/schemas/ContainerExtraFields"},{"type":"null"}]},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"User defined additional fields for this order."},"vehicle_category":{"anyOf":[{"$ref":"#/components/schemas/VehicleCategory"},{"type":"null"}],"title":"Vehicle category"},"palletforce":{"anyOf":[{"$ref":"#/components/schemas/PalletforceExtraFields"},{"type":"null"}],"title":"Palletforce specific fields"},"kuehne_nagel":{"anyOf":[{"$ref":"#/components/schemas/KuehneNagelExtraFields"},{"type":"null"}],"title":"Kuehn Nagel specific fields"},"palletline":{"anyOf":[{"$ref":"#/components/schemas/PalletlineExtraFields"},{"type":"null"}],"title":"Palletline specific fields"},"transporeon":{"anyOf":[{"$ref":"#/components/schemas/TransporeonOrderExtraFields"},{"type":"null"}],"title":"Transporeon specific fields"},"dachser":{"anyOf":[{"$ref":"#/components/schemas/DachserExtraFields"},{"type":"null"}],"title":"Dachser specific fields"},"contact_emails":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Contact Emails","description":"List of contact emails to notify about the order"},"import_export":{"anyOf":[{"$ref":"#/components/schemas/ImportExportExtraFields"},{"type":"null"}],"title":"Fields specific to import and export"},"is_consignment_info_validated":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Consignment Info Validated","description":"Flag indicating all consignment information is validated. Customers can only set this to true; only planners (or API/internal callers) can revert it."},"stops":{"anyOf":[{"items":{"$ref":"#/components/schemas/StopOutput-Input"},"type":"array"},{"type":"null"}],"title":"Stops","description":"List of stops in the order, ordered by their sequence"},"order_identifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Order Identifier","description":"Identifier of the order when created from an external source"},"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier for order"},"consignments":{"items":{"$ref":"#/components/schemas/OrderConsignmentOutput-Input"},"type":"array","title":"Consignments"},"pricing":{"anyOf":[{"$ref":"#/components/schemas/OrderPricingOutput"},{"type":"null"}],"description":"Pricing fields related to order"},"customer":{"$ref":"#/components/schemas/CompanyOutput-Input","title":"Customer"},"created_by_user":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By User","description":"User who created the order"},"created_timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created Timestamp","description":"Timestamp of creation"},"start_stop":{"anyOf":[{"$ref":"#/components/schemas/StopOutput-Input"},{"type":"null"}],"description":"First stop on this order"},"end_stop":{"anyOf":[{"$ref":"#/components/schemas/StopOutput-Input"},{"type":"null"}],"description":"Last stop on this order"},"quote_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quote Name","description":"Name of the quote"},"container_load_unload_stop":{"anyOf":[{"$ref":"#/components/schemas/StopOutput-Input"},{"type":"null"}],"title":"Container load/unload stop","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field practically maps to the container yard. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"setup_stops"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (for pick-up) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"teardown_stops"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (for drop-off) are replacing this field, please use them instead."},"children":[]}]}]}],"deprecated":true}},"type":"object","required":["id","consignments","customer"],"title":"DispatchOrderOutput"}},"components/schemas/DispatchResourceAllocation":{"id":"components/schemas/DispatchResourceAllocation","kind":"json-schema","title":"DispatchResourceAllocation","data":{"properties":{"resource":{"anyOf":[{"$ref":"#/components/schemas/GenericResource-Input"},{"$ref":"#/components/schemas/DriverResource-Input"},{"$ref":"#/components/schemas/ContainerResource-Input"},{"$ref":"#/components/schemas/VehicleResource-Input"}],"title":"Resource","description":"Resource assigned to the trip"},"execution":{"anyOf":[{"$ref":"#/components/schemas/DispatchExecution"},{"type":"null"}],"description":"Contains dispatch related information"}},"type":"object","required":["resource"],"title":"DispatchResourceAllocation"}},"components/schemas/Document":{"id":"components/schemas/Document","kind":"json-schema","title":"Document","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier of the document"},"name":{"type":"string","title":"Name","description":"Name of the document"},"type":{"type":"string","title":"Type","description":"Type of the document"},"download_url":{"type":"string","title":"Download Url","description":"Relative URL from the base URL to download the document","default":""},"subject_type":{"type":"string","title":"Subject Type","description":"Linked subject of the document"},"content_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content Type","description":"Content type of the document"}},"type":"object","required":["id","name","type","subject_type"],"title":"Document"}},"components/schemas/DocumentImportResponse":{"id":"components/schemas/DocumentImportResponse","kind":"json-schema","title":"DocumentImportResponse","data":{"properties":{"errors":{"anyOf":[{"items":{"$ref":"#/components/schemas/ErrorStatus"},"type":"array"},{"type":"null"}],"title":"Errors","description":"List of errors that occurred during the webhook processing. If empty/omitted, the webhook was processed successfully.","examples":[{"error_message":"The payload is invalid.","error_type":"USER_INPUT_ERROR"},{"error_message":"Not supported.","error_type":"NOT_SUPPORTED"},{"error_message":"Unknown error.","error_type":"INTERNAL_ERROR"}]}},"type":"object","title":"DocumentImportResponse","description":"Response schema for the document import webhook.\nThis schema is used to return errors or success messages."}},"components/schemas/DocumentUpdate":{"id":"components/schemas/DocumentUpdate","kind":"json-schema","title":"DocumentUpdate","data":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id"},"type":{"type":"string","const":"Document","title":"Type"},"status":{"$ref":"#/components/schemas/VisibilityDocumentStatus"},"document":{"$ref":"#/components/schemas/VisibilityDocument"}},"type":"object","required":["type","status","document"],"title":"DocumentUpdate","description":"Send update event when a document is uploaded to Qargo."}},"components/schemas/DocumentUploadResponse":{"id":"components/schemas/DocumentUploadResponse","kind":"json-schema","title":"DocumentUploadResponse","data":{"properties":{"upload_id":{"type":"string","format":"uuid","title":"Upload Id","description":"Unique identifier for the uploaded document"}},"type":"object","required":["upload_id"],"title":"DocumentUploadResponse"}},"components/schemas/DriverDocumentTypes":{"id":"components/schemas/DriverDocumentTypes","kind":"json-schema","title":"DriverDocumentTypes","data":{"type":"string","enum":["A1_DOCUMENT","CARGO_INSURANCE","BBS_CERTIFICATE","COMMUNICATION_SUBCONTRACTOR","DOMESTIC_CARGO_INSURANCE","DRIVER_ADR_LICENSE","DRIVER_AEO_REGULATED_AGENT_LICENSE","DRIVER_ALFAPASS","DRIVER_CARD","DRIVER_CARGOCARD_ACCESS_CARD","DRIVER_CIVIL_LIABILITY_EXPLOITATION","DRIVER_CIVIL_LIABILITY_INSURANCE","DRIVER_CODE_95","DRIVER_CPC_CARD","DRIVER_DRIVING_LICENSE","DRIVER_IDENTITY_CARD","DRIVER_IMI_PORTAL","DRIVER_INSURANCE","DRIVER_LONG_HEAVY_VEHICLE_CERT","DRIVER_MEDICAL_EXAM","DRIVER_PERSONAL_PROTECTIVE_EQUIPMENT","DRIVER_POSTING_DOCUMENT","DRIVER_REFUGEE_TRAINING_LICENSE","DRIVER_SICK_NOTE","DRIVER_TRAINING","EUROVIGNET","EXCEPTIONAL_TRANSPORT_LICENSE","FINE","FORKLIFT_LICENSE","FUEL_CARD","OTHER","PAYSCALE_DRIVER","SAFETY_CERTIFICATE_TERMINAL","SITE_MOVEMENT_SHEET","TOLL_CARD","VCA_BASIC_SAFETY","VEHICLE_ADR_CERTIFICATE"],"title":"DriverDocumentTypes"}},"components/schemas/DriverMatchInput":{"id":"components/schemas/DriverMatchInput","kind":"json-schema","title":"DriverMatchInput","data":{"properties":{"name":{"anyOf":[{"$ref":"#/components/schemas/FieldMatchInput"},{"type":"null"}]},"generic_id":{"anyOf":[{"$ref":"#/components/schemas/FieldMatchInput"},{"type":"null"}]},"integration_object_id":{"anyOf":[{"$ref":"#/components/schemas/FieldMatchInput"},{"type":"null"}],"description":"The resource ID in the given context of your integration. "}},"type":"object","title":"DriverMatchInput","example":{"name":{"matches_any":["John Doe"]}}}},"components/schemas/DriverMode":{"id":"components/schemas/DriverMode","kind":"json-schema","title":"DriverMode","data":{"type":"string","enum":["ACCOMPANIED","UNACCOMPANIED"],"title":"DriverMode"}},"components/schemas/DriverProperties":{"id":"components/schemas/DriverProperties","kind":"json-schema","title":"DriverProperties","data":{"properties":{"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name","description":"First name of the driver"},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name","description":"Last name of the driver"},"email_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email Address","description":"Email of the driver"},"date_of_birth":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date Of Birth","description":"Date of birth of the driver","examples":["2025-04-10"]},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number","description":"Phone number of the driver","examples":["+32412345678"]},"start_stop_location":{"anyOf":[{"$ref":"#/components/schemas/LocationReference"},{"type":"null"}],"description":"Location used as the driver's start and stop location for planning. Must reference a valid location in the tenant's location master data. Set to null to remove the start/stop location."}},"type":"object","title":"DriverProperties"}},"components/schemas/DriverResource-Input":{"id":"components/schemas/DriverResource-Input","kind":"json-schema","title":"DriverResource","data":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"ID of the resource"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the resource"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code of the resource"},"is_archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Archived","description":"Is the resource archived"},"is_external_resource":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is External Resource","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Read-only. True if this is a non-owned (subcontractor) resource. When this resource appears inside a trip, name / license_plate / container_number reflect the per-trip override value if one was set on the resource allocation; otherwise the resource master value is returned. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the value is not yet projected — treat as internal for backwards compatibility."},"children":[]}]}]}],"examples":[true]},"custom_fields":{"type":"object","title":"Custom Fields","description":"Store values for user defined fields"},"subcontractor":{"anyOf":[{"$ref":"#/components/schemas/CompanyOutput-Input"},{"type":"null"}],"description":"Subcontractor linked to the resource"},"resource_type":{"anyOf":[{"$ref":"#/components/schemas/ResourceTypeEnum"},{"type":"null"}],"description":"Type of the resource"},"date_of_birth":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date Of Birth","description":"Date of birth of the driver"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email","description":"Email of the driver"},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name","description":"First name of the driver"},"home_address":{"anyOf":[{"$ref":"#/components/schemas/LocationOutput"},{"type":"null"}],"description":"Home address of the driver"},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name","description":"Last name of the driver"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"Note about the driver"},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number","description":"Phone number of the driver"},"start_stop_location":{"anyOf":[{"$ref":"#/components/schemas/LocationReference"},{"type":"null"}],"description":"Location used as the driver's start and stop location for planning. Must reference a valid location. Set to null to unset the driver's start and stop location."}},"type":"object","title":"DriverResource"}},"components/schemas/DriverResource-Output":{"id":"components/schemas/DriverResource-Output","kind":"json-schema","title":"DriverResource","data":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"ID of the resource"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the resource"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code of the resource"},"is_archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Archived","description":"Is the resource archived"},"is_external_resource":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is External Resource","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Read-only. True if this is a non-owned (subcontractor) resource. When this resource appears inside a trip, name / license_plate / container_number reflect the per-trip override value if one was set on the resource allocation; otherwise the resource master value is returned. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the value is not yet projected — treat as internal for backwards compatibility."},"children":[]}]}]}],"examples":[true]},"custom_fields":{"type":"object","title":"Custom Fields","description":"Store values for user defined fields"},"subcontractor":{"anyOf":[{"$ref":"#/components/schemas/CompanyOutput-Output"},{"type":"null"}],"description":"Subcontractor linked to the resource"},"resource_type":{"anyOf":[{"$ref":"#/components/schemas/ResourceTypeEnum"},{"type":"null"}],"description":"Type of the resource"},"date_of_birth":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date Of Birth","description":"Date of birth of the driver"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email","description":"Email of the driver"},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name","description":"First name of the driver"},"home_address":{"anyOf":[{"$ref":"#/components/schemas/LocationOutput"},{"type":"null"}],"description":"Home address of the driver"},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name","description":"Last name of the driver"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"Note about the driver"},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number","description":"Phone number of the driver"},"start_stop_location":{"anyOf":[{"$ref":"#/components/schemas/LocationReference"},{"type":"null"}],"description":"Location used as the driver's start and stop location for planning. Must reference a valid location. Set to null to unset the driver's start and stop location."}},"type":"object","title":"DriverResource"}},"components/schemas/DriverResourceInput":{"id":"components/schemas/DriverResourceInput","kind":"json-schema","title":"DriverResourceInput","data":{"properties":{"is_archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Archived","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reactivate a previously archived resource, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to archive it. Only takes effect when included in the request; omit it to leave the archive state unchanged."},"children":[]}]}]}]},"billing_entity":{"anyOf":[{"$ref":"#/components/schemas/BillingEntityReference"},{"type":"null"}],"description":"Billing entity associated with the resource, defaults to default billing entity if not provided"},"extras":{"anyOf":[{"items":{"$ref":"#/components/schemas/ResourceExtraInput"},"type":"array"},{"type":"null"}],"title":"Extras","description":"Stop extras this resource is compatible with. Replaces the existing list when provided. Send an empty list to clear all compatible extras."},"name":{"type":"string","title":"Name","description":"Name of the resource"},"external_id":{"type":"string","title":"External Id","description":"External identifier of the resource","default":""},"locale":{"anyOf":[{"type":"string","pattern":"^[a-z]{2}(-[A-Z]{2})?$"},{"type":"null"}],"title":"Locale","description":"Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.","examples":["en","nl","en-GB","fr-BE"]},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code of the resource"},"note":{"type":"string","title":"Note","description":"Note about the resource","default":""},"custom_fields":{"type":"object","title":"Custom Fields","description":"User defined additional fields for this resource"},"subcontractor":{"anyOf":[{"$ref":"#/components/schemas/CompanyReference"},{"type":"null"}],"description":"Company linked to the resource"},"integrations":{"anyOf":[{"additionalProperties":{"type":"object"},"type":"object"},{"type":"null"}],"title":"Integrations","description":"Related integrations for the resource. The key is the unique code of the integration in Qargo","examples":[{"addsecure1234":{"active":true,"object_id":"1234"}}]},"driver":{"anyOf":[{"$ref":"#/components/schemas/DriverProperties"},{"type":"null"}],"description":"Driver specific properties"}},"type":"object","required":["name"],"title":"DriverResourceInput"}},"components/schemas/DriverResourceOutput":{"id":"components/schemas/DriverResourceOutput","kind":"json-schema","title":"DriverResourceOutput","data":{"properties":{"row_id":{"type":"string","format":"uuid","title":"Row Id","description":"Identifier of the reference"},"name":{"type":"string","title":"Name","description":"Name of the resource"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":"External identifier of the resource"},"locale":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Locale","description":"Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.","examples":["en","nl","en-GB","fr-BE"]},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code of the resource"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"Note about the resource"},"custom_fields":{"type":"object","title":"Custom Fields","description":"User defined additional fields for this resource"},"subcontractor":{"anyOf":[{"$ref":"#/components/schemas/CompanyReference"},{"type":"null"}],"description":"Company linked to the resource"},"integrations":{"anyOf":[{"additionalProperties":{"type":"object"},"type":"object"},{"type":"null"}],"title":"Integrations","description":"Related integrations for the resource. The key is the unique code of the integration in Qargo","examples":[{"addsecure1234":{"active":true,"object_id":"1234"}}]},"billing_entity":{"anyOf":[{"$ref":"#/components/schemas/BillingEntity"},{"type":"null"}],"description":"Billing entity associated with the resource"},"extras":{"items":{"$ref":"#/components/schemas/ResourceExtraOutput"},"type":"array","title":"Extras","description":"Stop extras this resource is compatible with"},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Active","description":"Is the resource active"},"is_external_resource":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is External Resource","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Read-only. True if this is a non-owned (subcontractor) resource. When this resource appears inside a trip, name / license_plate / container_number reflect the per-trip override value if one was set on the resource allocation; otherwise the resource master value is returned. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the value is not yet projected — treat as internal for backwards compatibility."},"children":[]}]}]}],"examples":[true]},"timestamp_updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp Updated","description":"Timestamp of the last update of the resource"},"resource_groups":{"items":{"$ref":"#/components/schemas/ResourceGroupOutput"},"type":"array","title":"Resource Groups","description":"Resource groups this resource currently belongs to (deduplicated and sorted by name). A resource can belong to more than one group. Active allocations are included regardless of their validity window (scheduled, future, or expired); archived allocations are excluded."},"driver":{"anyOf":[{"$ref":"#/components/schemas/DriverProperties"},{"type":"null"}],"description":"Driver specific properties"}},"type":"object","required":["row_id","name"],"title":"DriverResourceOutput"}},"components/schemas/DropCollectEmptyInput":{"id":"components/schemas/DropCollectEmptyInput","kind":"json-schema","title":"DropCollectEmptyInput","data":{"properties":{"location":{"anyOf":[{"$ref":"#/components/schemas/Location"},{"type":"null"}],"description":"Location of an additional drop/collect. This location will be added after the stop this is associated with."},"date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date","description":"Date the main drop/collect","examples":["2024-12-31"]}},"type":"object","title":"DropCollectEmptyInput"}},"components/schemas/EInvoiceAttachment":{"id":"components/schemas/EInvoiceAttachment","kind":"json-schema","title":"EInvoiceAttachment","data":{"properties":{"document":{"$ref":"#/components/schemas/EInvoiceDocumentAttachment"}},"type":"object","required":["document"],"title":"EInvoiceAttachment"}},"components/schemas/EInvoiceCompanyInput":{"id":"components/schemas/EInvoiceCompanyInput","kind":"json-schema","title":"EInvoiceCompanyInput","data":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"The unique identifier of the company."},"name":{"type":"string","title":"Name","description":"Name of the company.","examples":["John Doe"]},"vat_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vat Number","description":"VAT number of the company.","examples":["BE1234.123.123"]},"billing_location":{"anyOf":[{"$ref":"#/components/schemas/Location"},{"type":"null"}],"description":"Billing address of the company."}},"type":"object","required":["name"],"title":"EInvoiceCompanyInput"}},"components/schemas/EInvoiceDocumentAttachment":{"id":"components/schemas/EInvoiceDocumentAttachment","kind":"json-schema","title":"EInvoiceDocumentAttachment","data":{"properties":{"base64":{"type":"string","title":"Base64","description":"Base64 encoded content of the document attachment."},"content_type":{"type":"string","title":"Content Type","description":"MIME type of the document attachment, e.g., 'application/pdf', 'application/xml'."},"document_type":{"$ref":"#/components/schemas/EInvoiceDocumentType","description":"Type of the document attachment."},"filename":{"type":"string","title":"Filename","description":"Filename of the document attachment."}},"type":"object","required":["base64","content_type","document_type","filename"],"title":"EInvoiceDocumentAttachment"}},"components/schemas/EInvoiceDocumentType":{"id":"components/schemas/EInvoiceDocumentType","kind":"json-schema","title":"EInvoiceDocumentType","data":{"type":"string","enum":["INVOICE","CREDIT_NOTE","OTHER"],"title":"EInvoiceDocumentType"}},"components/schemas/EInvoiceLineItem":{"id":"components/schemas/EInvoiceLineItem","kind":"json-schema","title":"EInvoiceLineItem","data":{"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Freeform description field.","default":"","examples":["Charge description"]},"amount":{"anyOf":[{"type":"number"},{"type":"string"}],"title":"Amount","description":"Amount of the charge line.","examples":["100"]},"account":{"anyOf":[{"$ref":"#/components/schemas/api__order__models__charge__AccountInput"},{"type":"null"}],"description":"Accounting account associated with this line item."},"tax_rate":{"anyOf":[{"$ref":"#/components/schemas/api__accounting__models__invoice__TaxRate"},{"type":"null"}],"description":"Tax rate applied to this line item."},"currency":{"type":"string","title":"Currency","description":"Currency of the line item.","examples":["USD"]},"references":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"References","description":"References associated with this line item.","examples":[{"order_name":"OR-1234"}]}},"type":"object","required":["amount","currency"],"title":"EInvoiceLineItem"}},"components/schemas/EInvoicingOutput":{"id":"components/schemas/EInvoicingOutput","kind":"json-schema","title":"EInvoicingOutput","data":{"properties":{"number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Number","description":"E-invoicing registration number."},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url","description":"E-invoicing verification URL."},"regulator":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Regulator","description":"E-invoicing regulator."}},"type":"object","title":"EInvoicingOutput"}},"components/schemas/EWC":{"id":"components/schemas/EWC","kind":"json-schema","title":"EWC","data":{"properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Six-digit European Waste Catalogue code, without spaces or the hazardous asterisk.","examples":["060502"]},"is_hazardous":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Hazardous","description":"Whether the code carries an asterisk in the official list. Derived from the code; read-only."},"entry_type":{"anyOf":[{"$ref":"#/components/schemas/EWCEntryType"},{"type":"null"}],"description":"Classification following Commission notice 2018/C 124/01. Mirror entries are ones where the asterisk alone does not decide hazardousness. Derived from the code; read-only."},"description_by_locale":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Description By Locale","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EWC description by locale, generated from EWC master data. This field is read-only; values submitted during order import are ignored. Keys, when present, are one of: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en-GB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en-US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nl-BE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fi-FI"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fr-FR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"de-DE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"it-IT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"es-ES"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hu-HU"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pt-PT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tr-TR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pl-PL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ro-RO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ru-RU"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bg-BG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lt-LT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mk-MK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cs-CZ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Values are the corresponding localized descriptions."},"children":[]}]}]}],"examples":[{"en":"wastes containing other heavy metals"}]}},"type":"object","title":"EWC"}},"components/schemas/EWCEntryType":{"id":"components/schemas/EWCEntryType","kind":"json-schema","title":"EWCEntryType","data":{"type":"string","enum":["ABSOLUTE_HAZARDOUS","ABSOLUTE_NON_HAZARDOUS","MIRROR_HAZARDOUS","MIRROR_NON_HAZARDOUS"],"title":"EWCEntryType"}},"components/schemas/EWCInput":{"id":"components/schemas/EWCInput","kind":"json-schema","title":"EWCInput","data":{"properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Six-digit European Waste Catalogue code, without spaces or the hazardous asterisk. Matched against the EWC catalogue"}},"type":"object","title":"EWCInput"}},"components/schemas/EmbeddedDocument":{"id":"components/schemas/EmbeddedDocument","kind":"json-schema","title":"EmbeddedDocument","data":{"properties":{"content":{"type":"string","title":"Content","description":"A base64 encoded representation of the document"},"mime_type":{"type":"string","title":"Mime Type","description":"A valid mime-type as per IANA specifications (https://www.iana.org/assignments/media-types/media-types.xhtml)","examples":["application/json","application/pdf"]},"filename":{"type":"string","title":"Filename"}},"type":"object","required":["content","mime_type","filename"],"title":"EmbeddedDocument"}},"components/schemas/Entity":{"id":"components/schemas/Entity","kind":"json-schema","title":"Entity","data":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Human readable identifier"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Machine readable identifier"}},"type":"object","title":"Entity"}},"components/schemas/ErrorStatus":{"id":"components/schemas/ErrorStatus","kind":"json-schema","title":"ErrorStatus","data":{"properties":{"error_type":{"$ref":"#/components/schemas/ErrorType"},"error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Message","description":"(User visible) error message"}},"type":"object","required":["error_type"],"title":"ErrorStatus"}},"components/schemas/ErrorType":{"id":"components/schemas/ErrorType","kind":"json-schema","title":"ErrorType","data":{"type":"string","enum":["USER_INPUT_ERROR","INTERNAL_ERROR","NOT_SUPPORTED"],"title":"ErrorType"}},"components/schemas/EtaUpdate":{"id":"components/schemas/EtaUpdate","kind":"json-schema","title":"EtaUpdate","data":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id"},"type":{"type":"string","const":"Eta","title":"Type"},"stops":{"items":{"$ref":"#/components/schemas/VisibilityStop"},"type":"array","minItems":1,"title":"Stops","description":"List of stops with updated ETAs"}},"type":"object","required":["type","stops"],"title":"EtaUpdate","description":"Send update event on stop ETA change."}},"components/schemas/ExchangeRate":{"id":"components/schemas/ExchangeRate","kind":"json-schema","title":"ExchangeRate","data":{"properties":{"rate_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Rate Date","examples":["2022-01-01"]},"rate":{"type":"number","title":"Rate","examples":[1]},"inverse_rate":{"type":"number","title":"Inverse Rate","examples":[1]}},"type":"object","required":["rate","inverse_rate"],"title":"ExchangeRate"}},"components/schemas/ExchangeRateInput":{"id":"components/schemas/ExchangeRateInput","kind":"json-schema","title":"ExchangeRateInput","data":{"properties":{"exchange_rate":{"anyOf":[{"type":"number","exclusiveMinimum":0},{"type":"string"}],"title":"Exchange Rate","description":"The exchange rate value. Must be a positive number."},"exchange_rate_date":{"type":"string","format":"date","title":"Exchange Rate Date","description":"The date for this exchange rate."},"from_currency":{"$ref":"#/components/schemas/CurrencyCode","description":"Source currency code (ISO 4217)."},"to_currency":{"$ref":"#/components/schemas/CurrencyCode","description":"Target currency code (ISO 4217)."},"inverse_exchange_rate":{"anyOf":[{"type":"number","exclusiveMinimum":0},{"type":"string"}],"title":"Inverse Exchange Rate","description":"The inverse exchange rate value. Must be a positive number."}},"type":"object","required":["exchange_rate","exchange_rate_date","from_currency","to_currency","inverse_exchange_rate"],"title":"ExchangeRateInput"}},"components/schemas/ExchangeRateOutput":{"id":"components/schemas/ExchangeRateOutput","kind":"json-schema","title":"ExchangeRateOutput","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The unique identifier for the exchange rate."},"exchange_rate":{"type":"number","title":"Exchange Rate","description":"The exchange rate value."},"exchange_rate_date":{"type":"string","format":"date","title":"Exchange Rate Date","description":"The date for this exchange rate."},"from_currency":{"$ref":"#/components/schemas/CurrencyCode","description":"Source currency code (ISO 4217)."},"to_currency":{"$ref":"#/components/schemas/CurrencyCode","description":"Target currency code (ISO 4217)."},"inverse_exchange_rate":{"type":"number","title":"Inverse Exchange Rate","description":"The inverse exchange rate value."}},"type":"object","required":["id","exchange_rate","exchange_rate_date","from_currency","to_currency","inverse_exchange_rate"],"title":"ExchangeRateOutput"}},"components/schemas/ExecutionStatusUpdate":{"id":"components/schemas/ExecutionStatusUpdate","kind":"json-schema","title":"ExecutionStatusUpdate","data":{"properties":{"execution_statuses":{"items":{"$ref":"#/components/schemas/BookingExecutionStatus"},"type":"array","title":"Execution Statuses","description":"List of execution statuses to update"}},"type":"object","title":"ExecutionStatusUpdate"}},"components/schemas/ExportDeclarationTypeEnum":{"id":"components/schemas/ExportDeclarationTypeEnum","kind":"json-schema","title":"ExportDeclarationTypeEnum","data":{"type":"string","enum":["EU","EX"],"title":"ExportDeclarationTypeEnum"}},"components/schemas/ExternalExecutionMetadata":{"id":"components/schemas/ExternalExecutionMetadata","kind":"json-schema","title":"ExternalExecutionMetadata","data":{"properties":{"completed":{"type":"boolean","title":"Completed","default":false}},"type":"object","title":"ExternalExecutionMetadata"}},"components/schemas/ExtraField":{"id":"components/schemas/ExtraField","kind":"json-schema","title":"ExtraField","data":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Human readable identifier"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Machine readable identifier"},"custom_fields":{"type":"object","title":"Custom Fields","description":"Store values for user defined fields"}},"type":"object","title":"ExtraField"}},"components/schemas/FieldMatchInput":{"id":"components/schemas/FieldMatchInput","kind":"json-schema","title":"FieldMatchInput","data":{"properties":{"matches_any":{"items":{"type":"string"},"type":"array","title":"Matches Any"}},"type":"object","title":"FieldMatchInput"}},"components/schemas/FixedTimestampType":{"id":"components/schemas/FixedTimestampType","kind":"json-schema","title":"FixedTimestampType","data":{"type":"string","enum":["ENFORCED_TIMEWINDOW","SET_BY_USER","CALCULATED"],"title":"FixedTimestampType"}},"components/schemas/FleetDispatch":{"id":"components/schemas/FleetDispatch","kind":"json-schema","title":"FleetDispatch","data":{"properties":{"operation":{"$ref":"#/components/schemas/DispatchOperation"},"payload":{"$ref":"#/components/schemas/FleetDispatchOutput"}},"type":"object","required":["operation","payload"],"title":"FleetDispatch"}},"components/schemas/FleetDispatchOutput":{"id":"components/schemas/FleetDispatchOutput","kind":"json-schema","title":"FleetDispatchOutput","data":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"ID of the dispatched trip"},"name":{"type":"string","title":"Name"},"orders":{"items":{"$ref":"#/components/schemas/DispatchOrder"},"type":"array","title":"Orders"},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"Custom fields of the dispatched trip"},"resource_allocations":{"anyOf":[{"items":{"$ref":"#/components/schemas/DispatchResourceAllocation"},"type":"array"},{"type":"null"}],"title":"Resource Allocations"},"stop_groups":{"items":{"$ref":"#/components/schemas/StopGroup"},"type":"array","title":"Stop Groups","description":"List of stop groups"},"templates":{"items":{"$ref":"#/components/schemas/FleetDispatchTemplate"},"type":"array","title":"Templates","description":"List of templates to be rendered on the fleet device"}},"type":"object","required":["name","orders","resource_allocations","stop_groups","templates"],"title":"FleetDispatchOutput"}},"components/schemas/FleetDispatchResponse":{"id":"components/schemas/FleetDispatchResponse","kind":"json-schema","title":"FleetDispatchResponse","data":{"properties":{"errors":{"anyOf":[{"items":{"$ref":"#/components/schemas/ErrorStatus"},"type":"array"},{"type":"null"}],"title":"Errors","description":"List of errors that occurred during the webhook processing. If empty/omitted, the webhook was processed successfully.","examples":[{"error_message":"The payload is invalid.","error_type":"USER_INPUT_ERROR"},{"error_message":"Not supported.","error_type":"NOT_SUPPORTED"},{"error_message":"Unknown error.","error_type":"INTERNAL_ERROR"}]}},"type":"object","title":"FleetDispatchResponse","description":"Response schema for the subcontractor dispatch payload.\nThis schema is used to return errors or success messages."}},"components/schemas/FleetDispatchStatusUpdate":{"id":"components/schemas/FleetDispatchStatusUpdate","kind":"json-schema","title":"FleetDispatchStatusUpdate","data":{"properties":{"stop":{"$ref":"#/components/schemas/StopStatusUpdate","description":"Update a stop. Can update status and data of a stop.\n        Updates on the data are based on a mapping defined in Qargo"},"event_time":{"type":"string","format":"date-time","title":"Event Time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time of the event in UTC. Include a timezone offset, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+02:00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"stop_group":{"anyOf":[{"$ref":"#/components/schemas/StopGroupStatusUpdate"},{"type":"null"}],"description":"Stops can be grouped together according to their activity and location.\n        This is called a stop group. \nUpdate a stop group. Can update status and data of the stops in a stop group.\n        Updates on the data are based on a mapping defined in Qargo. The updates apply to each stop in the group."}},"type":"object","required":["stop","event_time","stop_group"],"title":"FleetDispatchStatusUpdate"}},"components/schemas/FleetDispatchTemplate":{"id":"components/schemas/FleetDispatchTemplate","kind":"json-schema","title":"FleetDispatchTemplate","data":{"properties":{"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title","description":"Title to be displayed on fleet app"},"subtitle":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subtitle","description":"Subtitle to be displayed on fleet app"}},"type":"object","title":"FleetDispatchTemplate"}},"components/schemas/FleetStatusUpdatePayload":{"id":"components/schemas/FleetStatusUpdatePayload","kind":"json-schema","title":"FleetStatusUpdatePayload","data":{"properties":{"updates":{"items":{"$ref":"#/components/schemas/FleetDispatchStatusUpdate"},"type":"array","title":"Updates","description":"List of status updates for stops and stop groups"}},"type":"object","required":["updates"],"title":"FleetStatusUpdatePayload"}},"components/schemas/FullTrailerResourceInput":{"id":"components/schemas/FullTrailerResourceInput","kind":"json-schema","title":"FullTrailerResourceInput","data":{"properties":{"is_archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Archived","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reactivate a previously archived resource, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to archive it. Only takes effect when included in the request; omit it to leave the archive state unchanged."},"children":[]}]}]}]},"billing_entity":{"anyOf":[{"$ref":"#/components/schemas/BillingEntityReference"},{"type":"null"}],"description":"Billing entity associated with the resource, defaults to default billing entity if not provided"},"extras":{"anyOf":[{"items":{"$ref":"#/components/schemas/ResourceExtraInput"},"type":"array"},{"type":"null"}],"title":"Extras","description":"Stop extras this resource is compatible with. Replaces the existing list when provided. Send an empty list to clear all compatible extras."},"name":{"type":"string","title":"Name","description":"Name of the resource"},"external_id":{"type":"string","title":"External Id","description":"External identifier of the resource","default":""},"locale":{"anyOf":[{"type":"string","pattern":"^[a-z]{2}(-[A-Z]{2})?$"},{"type":"null"}],"title":"Locale","description":"Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.","examples":["en","nl","en-GB","fr-BE"]},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code of the resource"},"note":{"type":"string","title":"Note","description":"Note about the resource","default":""},"custom_fields":{"type":"object","title":"Custom Fields","description":"User defined additional fields for this resource"},"subcontractor":{"anyOf":[{"$ref":"#/components/schemas/CompanyReference"},{"type":"null"}],"description":"Company linked to the resource"},"integrations":{"anyOf":[{"additionalProperties":{"type":"object"},"type":"object"},{"type":"null"}],"title":"Integrations","description":"Related integrations for the resource. The key is the unique code of the integration in Qargo","examples":[{"addsecure1234":{"active":true,"object_id":"1234"}}]},"full_trailer":{"anyOf":[{"$ref":"#/components/schemas/TrailerProperties-Input"},{"type":"null"}],"description":"Trailer specific properties"}},"type":"object","required":["name"],"title":"FullTrailerResourceInput"}},"components/schemas/FullTrailerResourceOutput":{"id":"components/schemas/FullTrailerResourceOutput","kind":"json-schema","title":"FullTrailerResourceOutput","data":{"properties":{"row_id":{"type":"string","format":"uuid","title":"Row Id","description":"Identifier of the reference"},"name":{"type":"string","title":"Name","description":"Name of the resource"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":"External identifier of the resource"},"locale":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Locale","description":"Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.","examples":["en","nl","en-GB","fr-BE"]},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code of the resource"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"Note about the resource"},"custom_fields":{"type":"object","title":"Custom Fields","description":"User defined additional fields for this resource"},"subcontractor":{"anyOf":[{"$ref":"#/components/schemas/CompanyReference"},{"type":"null"}],"description":"Company linked to the resource"},"integrations":{"anyOf":[{"additionalProperties":{"type":"object"},"type":"object"},{"type":"null"}],"title":"Integrations","description":"Related integrations for the resource. The key is the unique code of the integration in Qargo","examples":[{"addsecure1234":{"active":true,"object_id":"1234"}}]},"billing_entity":{"anyOf":[{"$ref":"#/components/schemas/BillingEntity"},{"type":"null"}],"description":"Billing entity associated with the resource"},"extras":{"items":{"$ref":"#/components/schemas/ResourceExtraOutput"},"type":"array","title":"Extras","description":"Stop extras this resource is compatible with"},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Active","description":"Is the resource active"},"is_external_resource":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is External Resource","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Read-only. True if this is a non-owned (subcontractor) resource. When this resource appears inside a trip, name / license_plate / container_number reflect the per-trip override value if one was set on the resource allocation; otherwise the resource master value is returned. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the value is not yet projected — treat as internal for backwards compatibility."},"children":[]}]}]}],"examples":[true]},"timestamp_updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp Updated","description":"Timestamp of the last update of the resource"},"resource_groups":{"items":{"$ref":"#/components/schemas/ResourceGroupOutput"},"type":"array","title":"Resource Groups","description":"Resource groups this resource currently belongs to (deduplicated and sorted by name). A resource can belong to more than one group. Active allocations are included regardless of their validity window (scheduled, future, or expired); archived allocations are excluded."},"full_trailer":{"anyOf":[{"$ref":"#/components/schemas/TrailerProperties-Output"},{"type":"null"}],"description":"Trailer specific properties"}},"type":"object","required":["row_id","name"],"title":"FullTrailerResourceOutput"}},"components/schemas/Gateway":{"id":"components/schemas/Gateway","kind":"json-schema","title":"Gateway","data":{"properties":{"name":{"type":"string","title":"Name"}},"type":"object","required":["name"],"title":"Gateway"}},"components/schemas/GenericResource-Input":{"id":"components/schemas/GenericResource-Input","kind":"json-schema","title":"GenericResource","data":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"ID of the resource"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the resource"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code of the resource"},"is_archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Archived","description":"Is the resource archived"},"is_external_resource":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is External Resource","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Read-only. True if this is a non-owned (subcontractor) resource. When this resource appears inside a trip, name / license_plate / container_number reflect the per-trip override value if one was set on the resource allocation; otherwise the resource master value is returned. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the value is not yet projected — treat as internal for backwards compatibility."},"children":[]}]}]}],"examples":[true]},"custom_fields":{"type":"object","title":"Custom Fields","description":"Store values for user defined fields"},"subcontractor":{"anyOf":[{"$ref":"#/components/schemas/CompanyOutput-Input"},{"type":"null"}],"description":"Subcontractor linked to the resource"},"resource_type":{"anyOf":[{"$ref":"#/components/schemas/ResourceTypeEnum"},{"type":"null"}],"description":"Type of the resource"}},"type":"object","title":"GenericResource"}},"components/schemas/GenericResource-Output":{"id":"components/schemas/GenericResource-Output","kind":"json-schema","title":"GenericResource","data":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"ID of the resource"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the resource"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code of the resource"},"is_archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Archived","description":"Is the resource archived"},"is_external_resource":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is External Resource","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Read-only. True if this is a non-owned (subcontractor) resource. When this resource appears inside a trip, name / license_plate / container_number reflect the per-trip override value if one was set on the resource allocation; otherwise the resource master value is returned. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the value is not yet projected — treat as internal for backwards compatibility."},"children":[]}]}]}],"examples":[true]},"custom_fields":{"type":"object","title":"Custom Fields","description":"Store values for user defined fields"},"subcontractor":{"anyOf":[{"$ref":"#/components/schemas/CompanyOutput-Output"},{"type":"null"}],"description":"Subcontractor linked to the resource"},"resource_type":{"anyOf":[{"$ref":"#/components/schemas/ResourceTypeEnum"},{"type":"null"}],"description":"Type of the resource"}},"type":"object","title":"GenericResource"}},"components/schemas/GoodData":{"id":"components/schemas/GoodData","kind":"json-schema","title":"GoodData","data":{"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"quantity":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Quantity"},"total_loading_meters":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Loading Meters"},"total_pallet_spaces":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Pallet Spaces"},"total_volume_m3":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Volume M3"},"total_weight_kg":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Weight Kg"},"unit_height_m":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Height M"},"unit_length_m":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Length M"},"unit_loading_meters":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Loading Meters"},"unit_pallet_spaces":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Pallet Spaces"},"unit_weight_kg":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Weight Kg"},"unit_width_m":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Width M"},"absolute_min_temperature_degrees":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Absolute Min Temperature Degrees"},"absolute_max_temperature_degrees":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Absolute Max Temperature Degrees"},"ordered_transport_temperature_degrees":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Ordered Transport Temperature Degrees"},"specific_gravity":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Specific Gravity"},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Custom Fields"},"adr_type":{"anyOf":[{"type":"string","enum":["ADR","LIMITED_QUANTITY"]},{"type":"null"}],"title":"Adr Type"},"waste_category":{"anyOf":[{"type":"string","enum":["WASTE","DANGEROUS_WASTE"]},{"type":"null"}],"title":"Waste Category"},"product":{"anyOf":[{"$ref":"#/components/schemas/GoodProductInput"},{"type":"null"}]},"extras":{"anyOf":[{"items":{"type":"object"},"type":"array"},{"type":"null"}],"title":"Extras"},"packaging_type":{"anyOf":[{"$ref":"#/components/schemas/GoodPackagingType"},{"type":"null"}]},"handling_units":{"anyOf":[{"items":{"$ref":"#/components/schemas/HandlingUnitData"},"type":"array"},{"type":"null"}],"title":"Handling Units"},"packaged_items":{"anyOf":[{"items":{"$ref":"#/components/schemas/PackagedItemInput"},"type":"array"},{"type":"null"}],"title":"Packaged Items"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id"},"hs_codes":{"anyOf":[{"$ref":"#/components/schemas/GoodHSCodesInput"},{"type":"null"}]}},"type":"object","title":"GoodData"}},"components/schemas/GoodEntityUpdate":{"id":"components/schemas/GoodEntityUpdate","kind":"json-schema","title":"GoodEntityUpdate","data":{"properties":{"operation":{"$ref":"#/components/schemas/UpdateOperation"},"data":{"anyOf":[{"$ref":"#/components/schemas/GoodUpdateData"},{"$ref":"#/components/schemas/GoodData"},{"type":"null"}],"title":"Data"}},"type":"object","required":["operation"],"title":"GoodEntityUpdate"}},"components/schemas/GoodHSCodesExtraFields":{"id":"components/schemas/GoodHSCodesExtraFields","kind":"json-schema","title":"GoodHSCodesExtraFields","data":{"properties":{"count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Count","description":"Number of HS codes for the good, used for customs rate calculation"}},"type":"object","title":"GoodHSCodesExtraFields"}},"components/schemas/GoodHSCodesInput":{"id":"components/schemas/GoodHSCodesInput","kind":"json-schema","title":"GoodHSCodesInput","data":{"properties":{"count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Count"}},"type":"object","title":"GoodHSCodesInput"}},"components/schemas/GoodInput-Input":{"id":"components/schemas/GoodInput-Input","kind":"json-schema","title":"GoodInput","data":{"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"quantity":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Quantity"},"total_loading_meters":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Loading Meters"},"total_pallet_spaces":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Pallet Spaces"},"total_volume_m3":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Volume M3"},"total_weight_kg":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Weight Kg"},"unit_height_m":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Height M"},"unit_length_m":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Length M"},"unit_loading_meters":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Loading Meters"},"unit_pallet_spaces":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Pallet Spaces"},"unit_weight_kg":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Weight Kg"},"unit_width_m":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Width M"},"stackable":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Stackable"},"packaged_items":{"items":{"$ref":"#/components/schemas/PackagedItem-Input"},"type":"array","title":"List of packaged items"},"adr_type":{"anyOf":[{"$ref":"#/components/schemas/ADRType"},{"type":"null"}]},"waste_category":{"anyOf":[{"$ref":"#/components/schemas/WasteCategory"},{"type":"null"}]},"absolute_min_temperature_degrees":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Absolute Min Temperature Degrees"},"absolute_max_temperature_degrees":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Absolute Max Temperature Degrees"},"ordered_transport_temperature_degrees":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Ordered Transport Temperature Degrees"},"specific_gravity":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Specific Gravity"},"product":{"anyOf":[{"$ref":"#/components/schemas/Product"},{"type":"null"}],"description":"Product information"},"packaging_type":{"anyOf":[{"$ref":"#/components/schemas/PackagingType"},{"type":"null"}],"description":"Packaging type, for example Pallet"},"extras":{"anyOf":[{"items":{"$ref":"#/components/schemas/ExtraField"},"type":"array"},{"type":"null"}],"title":"Extras","description":"Additional extra services/options for good"},"custom_fields":{"type":"object","title":"Custom Fields","description":"Store values for user defined fields"},"hs_codes":{"anyOf":[{"$ref":"#/components/schemas/GoodHSCodesExtraFields"},{"type":"null"}]},"handling_units":{"anyOf":[{"items":{"$ref":"#/components/schemas/HandlingUnitInput-Input"},"type":"array"},{"type":"null"}],"title":"Handling Units","description":"List of handling units. A handling unit is used to transport, store or handle goods","default":[]}},"type":"object","title":"GoodInput"}},"components/schemas/GoodInput-Output":{"id":"components/schemas/GoodInput-Output","kind":"json-schema","title":"GoodInput","data":{"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"quantity":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Quantity"},"total_loading_meters":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Loading Meters"},"total_pallet_spaces":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Pallet Spaces"},"total_volume_m3":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Volume M3"},"total_weight_kg":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Weight Kg"},"unit_height_m":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Height M"},"unit_length_m":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Length M"},"unit_loading_meters":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Loading Meters"},"unit_pallet_spaces":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Pallet Spaces"},"unit_weight_kg":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Weight Kg"},"unit_width_m":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Width M"},"stackable":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Stackable"},"packaged_items":{"items":{"$ref":"#/components/schemas/PackagedItem-Output"},"type":"array","title":"List of packaged items"},"adr_type":{"anyOf":[{"$ref":"#/components/schemas/ADRType"},{"type":"null"}]},"waste_category":{"anyOf":[{"$ref":"#/components/schemas/WasteCategory"},{"type":"null"}]},"absolute_min_temperature_degrees":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Absolute Min Temperature Degrees"},"absolute_max_temperature_degrees":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Absolute Max Temperature Degrees"},"ordered_transport_temperature_degrees":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Ordered Transport Temperature Degrees"},"specific_gravity":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Specific Gravity"},"product":{"anyOf":[{"$ref":"#/components/schemas/Product"},{"type":"null"}],"description":"Product information"},"packaging_type":{"anyOf":[{"$ref":"#/components/schemas/PackagingType"},{"type":"null"}],"description":"Packaging type, for example Pallet"},"extras":{"anyOf":[{"items":{"$ref":"#/components/schemas/ExtraField"},"type":"array"},{"type":"null"}],"title":"Extras","description":"Additional extra services/options for good"},"custom_fields":{"type":"object","title":"Custom Fields","description":"Store values for user defined fields"},"hs_codes":{"anyOf":[{"$ref":"#/components/schemas/GoodHSCodesExtraFields"},{"type":"null"}]},"handling_units":{"anyOf":[{"items":{"$ref":"#/components/schemas/HandlingUnitInput-Output"},"type":"array"},{"type":"null"}],"title":"Handling Units","description":"List of handling units. A handling unit is used to transport, store or handle goods","default":[]}},"type":"object","title":"GoodInput"}},"components/schemas/GoodMatch":{"id":"components/schemas/GoodMatch","kind":"json-schema","title":"GoodMatch","data":{"properties":{"id":{"anyOf":[{"$ref":"#/components/schemas/FieldMatchInput"},{"type":"null"}]}},"type":"object","title":"GoodMatch"}},"components/schemas/GoodOutput-Input":{"id":"components/schemas/GoodOutput-Input","kind":"json-schema","title":"GoodOutput","data":{"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"quantity":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Quantity"},"total_loading_meters":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Loading Meters"},"total_pallet_spaces":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Pallet Spaces"},"total_volume_m3":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Volume M3"},"total_weight_kg":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Weight Kg"},"unit_height_m":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Height M"},"unit_length_m":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Length M"},"unit_loading_meters":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Loading Meters"},"unit_pallet_spaces":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Pallet Spaces"},"unit_weight_kg":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Weight Kg"},"unit_width_m":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Width M"},"stackable":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Stackable"},"packaged_items":{"items":{"$ref":"#/components/schemas/PackagedItemOutput-Input"},"type":"array","title":"List of packaged items"},"adr_type":{"anyOf":[{"$ref":"#/components/schemas/ADRType"},{"type":"null"}]},"waste_category":{"anyOf":[{"$ref":"#/components/schemas/WasteCategory"},{"type":"null"}]},"absolute_min_temperature_degrees":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Absolute Min Temperature Degrees"},"absolute_max_temperature_degrees":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Absolute Max Temperature Degrees"},"ordered_transport_temperature_degrees":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Ordered Transport Temperature Degrees"},"specific_gravity":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Specific Gravity"},"product":{"anyOf":[{"$ref":"#/components/schemas/Product"},{"type":"null"}],"description":"Product information"},"packaging_type":{"anyOf":[{"$ref":"#/components/schemas/PackagingType"},{"type":"null"}],"description":"Packaging type, for example Pallet"},"extras":{"anyOf":[{"items":{"$ref":"#/components/schemas/ExtraField"},"type":"array"},{"type":"null"}],"title":"Extras","description":"Additional extra services/options for good"},"custom_fields":{"type":"object","title":"Custom Fields","description":"Store values for user defined fields"},"hs_codes":{"anyOf":[{"$ref":"#/components/schemas/GoodHSCodesExtraFields"},{"type":"null"}]},"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier for this good"},"incidents":{"anyOf":[{"items":{"$ref":"#/components/schemas/Incident"},"type":"array"},{"type":"null"}],"title":"Incidents","description":"List of incidents"},"handling_units":{"anyOf":[{"items":{"$ref":"#/components/schemas/HandlingUnitOutput-Input"},"type":"array"},{"type":"null"}],"title":"Handling Units","description":"List of handling units. A handling unit is used to transport, store or handle goods"},"actual_delivery_temperature_degrees":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Actual Delivery Temperature Degrees"},"actual_pickup_temperature_degrees":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Actual Pickup Temperature Degrees"}},"type":"object","required":["id"],"title":"GoodOutput"}},"components/schemas/GoodOutput-Output":{"id":"components/schemas/GoodOutput-Output","kind":"json-schema","title":"GoodOutput","data":{"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"quantity":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Quantity"},"total_loading_meters":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Loading Meters"},"total_pallet_spaces":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Pallet Spaces"},"total_volume_m3":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Volume M3"},"total_weight_kg":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Weight Kg"},"unit_height_m":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Height M"},"unit_length_m":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Length M"},"unit_loading_meters":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Loading Meters"},"unit_pallet_spaces":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Pallet Spaces"},"unit_weight_kg":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Weight Kg"},"unit_width_m":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Width M"},"stackable":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Stackable"},"packaged_items":{"items":{"$ref":"#/components/schemas/PackagedItemOutput-Output"},"type":"array","title":"List of packaged items"},"adr_type":{"anyOf":[{"$ref":"#/components/schemas/ADRType"},{"type":"null"}]},"waste_category":{"anyOf":[{"$ref":"#/components/schemas/WasteCategory"},{"type":"null"}]},"absolute_min_temperature_degrees":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Absolute Min Temperature Degrees"},"absolute_max_temperature_degrees":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Absolute Max Temperature Degrees"},"ordered_transport_temperature_degrees":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Ordered Transport Temperature Degrees"},"specific_gravity":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Specific Gravity"},"product":{"anyOf":[{"$ref":"#/components/schemas/Product"},{"type":"null"}],"description":"Product information"},"packaging_type":{"anyOf":[{"$ref":"#/components/schemas/PackagingType"},{"type":"null"}],"description":"Packaging type, for example Pallet"},"extras":{"anyOf":[{"items":{"$ref":"#/components/schemas/ExtraField"},"type":"array"},{"type":"null"}],"title":"Extras","description":"Additional extra services/options for good"},"custom_fields":{"type":"object","title":"Custom Fields","description":"Store values for user defined fields"},"hs_codes":{"anyOf":[{"$ref":"#/components/schemas/GoodHSCodesExtraFields"},{"type":"null"}]},"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier for this good"},"incidents":{"anyOf":[{"items":{"$ref":"#/components/schemas/Incident"},"type":"array"},{"type":"null"}],"title":"Incidents","description":"List of incidents"},"handling_units":{"anyOf":[{"items":{"$ref":"#/components/schemas/HandlingUnitOutput-Output"},"type":"array"},{"type":"null"}],"title":"Handling Units","description":"List of handling units. A handling unit is used to transport, store or handle goods"},"actual_delivery_temperature_degrees":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Actual Delivery Temperature Degrees"},"actual_pickup_temperature_degrees":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Actual Pickup Temperature Degrees"}},"type":"object","required":["id"],"title":"GoodOutput"}},"components/schemas/GoodPackagingSize":{"id":"components/schemas/GoodPackagingSize","kind":"json-schema","title":"GoodPackagingSize","data":{"properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},"type":"object","title":"GoodPackagingSize"}},"components/schemas/GoodPackagingType":{"id":"components/schemas/GoodPackagingType","kind":"json-schema","title":"GoodPackagingType","data":{"properties":{"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Custom Fields"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"packaging_size":{"anyOf":[{"$ref":"#/components/schemas/GoodPackagingSize"},{"type":"null"}]}},"type":"object","title":"GoodPackagingType"}},"components/schemas/GoodProductInput":{"id":"components/schemas/GoodProductInput","kind":"json-schema","title":"GoodProductInput","data":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"product_type":{"anyOf":[{"$ref":"#/components/schemas/GoodProductType"},{"type":"null"}]},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Custom Fields"}},"type":"object","title":"GoodProductInput"}},"components/schemas/GoodProductType":{"id":"components/schemas/GoodProductType","kind":"json-schema","title":"GoodProductType","data":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"}},"type":"object","title":"GoodProductType"}},"components/schemas/GoodUpdateData":{"id":"components/schemas/GoodUpdateData","kind":"json-schema","title":"GoodUpdateData","data":{"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"quantity":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Quantity"},"total_loading_meters":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Loading Meters"},"total_pallet_spaces":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Pallet Spaces"},"total_volume_m3":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Volume M3"},"total_weight_kg":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Weight Kg"},"unit_height_m":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Height M"},"unit_length_m":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Length M"},"unit_loading_meters":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Loading Meters"},"unit_pallet_spaces":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Pallet Spaces"},"unit_weight_kg":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Weight Kg"},"unit_width_m":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Width M"},"absolute_min_temperature_degrees":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Absolute Min Temperature Degrees"},"absolute_max_temperature_degrees":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Absolute Max Temperature Degrees"},"ordered_transport_temperature_degrees":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Ordered Transport Temperature Degrees"},"specific_gravity":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Specific Gravity"},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Custom Fields"},"adr_type":{"anyOf":[{"type":"string","enum":["ADR","LIMITED_QUANTITY"]},{"type":"null"}],"title":"Adr Type"},"waste_category":{"anyOf":[{"type":"string","enum":["WASTE","DANGEROUS_WASTE"]},{"type":"null"}],"title":"Waste Category"},"packaging_type":{"anyOf":[{"$ref":"#/components/schemas/GoodPackagingType"},{"type":"null"}]},"commodity_type":{"anyOf":[{"$ref":"#/components/schemas/GoodProductInput"},{"type":"null"}]},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id"},"hs_codes":{"anyOf":[{"$ref":"#/components/schemas/GoodHSCodesInput"},{"type":"null"}]}},"type":"object","title":"GoodUpdateData"}},"components/schemas/HSCode":{"id":"components/schemas/HSCode","kind":"json-schema","title":"HSCode","data":{"properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Harmonized System Code for the good"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Description of the HS code"}},"type":"object","title":"HSCode"}},"components/schemas/HSCodeField":{"id":"components/schemas/HSCodeField","kind":"json-schema","title":"HSCodeField","data":{"properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"}},"type":"object","title":"HSCodeField"}},"components/schemas/HTTPValidationError":{"id":"components/schemas/HTTPValidationError","kind":"json-schema","title":"HTTPValidationError","data":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}},"components/schemas/HandlingUnitData":{"id":"components/schemas/HandlingUnitData","kind":"json-schema","title":"HandlingUnitData","data":{"properties":{"barcode":{"anyOf":[{"$ref":"#/components/schemas/UpdateBarcodeInput"},{"type":"null"}]},"alternative_barcodes":{"anyOf":[{"items":{"$ref":"#/components/schemas/UpdateBarcodeInput"},"type":"array"},{"type":"null"}],"title":"Alternative Barcodes"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id"}},"type":"object","title":"HandlingUnitData"}},"components/schemas/HandlingUnitEntityUpdate":{"id":"components/schemas/HandlingUnitEntityUpdate","kind":"json-schema","title":"HandlingUnitEntityUpdate","data":{"properties":{"operation":{"$ref":"#/components/schemas/UpdateOperation"},"data":{"anyOf":[{"$ref":"#/components/schemas/HandlingUnitUpdateData"},{"$ref":"#/components/schemas/HandlingUnitData"},{"type":"null"}],"title":"Data"}},"type":"object","required":["operation"],"title":"HandlingUnitEntityUpdate"}},"components/schemas/HandlingUnitInput-Input":{"id":"components/schemas/HandlingUnitInput-Input","kind":"json-schema","title":"HandlingUnitInput","data":{"properties":{"barcode":{"anyOf":[{"$ref":"#/components/schemas/BarcodeInput"},{"type":"null"}],"description":"Barcode information"}},"type":"object","title":"HandlingUnitInput"}},"components/schemas/HandlingUnitInput-Output":{"id":"components/schemas/HandlingUnitInput-Output","kind":"json-schema","title":"HandlingUnitInput","data":{"properties":{"barcode":{"anyOf":[{"$ref":"#/components/schemas/BarcodeInput"},{"type":"null"}],"description":"Barcode information"}},"type":"object","title":"HandlingUnitInput"}},"components/schemas/HandlingUnitMatch":{"id":"components/schemas/HandlingUnitMatch","kind":"json-schema","title":"HandlingUnitMatch","data":{"properties":{"barcode":{"anyOf":[{"$ref":"#/components/schemas/FieldMatchInput"},{"type":"null"}]}},"type":"object","title":"HandlingUnitMatch"}},"components/schemas/HandlingUnitOutput-Input":{"id":"components/schemas/HandlingUnitOutput-Input","kind":"json-schema","title":"HandlingUnitOutput","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier for this handling unit"},"barcode":{"anyOf":[{"$ref":"#/components/schemas/BarcodeOutput"},{"type":"null"}],"description":"Barcode information"}},"type":"object","required":["id"],"title":"HandlingUnitOutput"}},"components/schemas/HandlingUnitOutput-Output":{"id":"components/schemas/HandlingUnitOutput-Output","kind":"json-schema","title":"HandlingUnitOutput","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier for this handling unit"},"barcode":{"anyOf":[{"$ref":"#/components/schemas/BarcodeOutput"},{"type":"null"}],"description":"Barcode information"}},"type":"object","required":["id"],"title":"HandlingUnitOutput"}},"components/schemas/HandlingUnitUpdate":{"id":"components/schemas/HandlingUnitUpdate","kind":"json-schema","title":"HandlingUnitUpdate","data":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id"},"type":{"type":"string","const":"HandlingUnit","title":"Type"},"status":{"$ref":"#/components/schemas/VisibilityHandlingUnitStatus","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Handling unit status. We only send an update for the following status updates:"},"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":"SCANNED_IN"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STORED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCANNED_OUT"},"children":[]}]}]}]}]},"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"Timestamp of the status change in UTC. For barcodes scans, this will be the timestamp at which the scan was performed."},"barcode":{"$ref":"#/components/schemas/BarcodeOutput","description":"Barcode information"},"created_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By","description":"User who created the scan"},"stop_location_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stop Location Code","description":"Optional code used to describe the location of the scan.","examples":["DEPOT-001"]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"source_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Status","description":"The status as provided to Qargo by an external system"},"stop":{"anyOf":[{"$ref":"#/components/schemas/VisibilityStop"},{"type":"null"}]}},"type":"object","required":["type","status","timestamp","barcode"],"title":"HandlingUnitUpdate","description":"Send update event when a handling unit is updated in Qargo."}},"components/schemas/HandlingUnitUpdateData":{"id":"components/schemas/HandlingUnitUpdateData","kind":"json-schema","title":"HandlingUnitUpdateData","data":{"properties":{"barcode":{"anyOf":[{"$ref":"#/components/schemas/UpdateBarcodeInput"},{"type":"null"}]},"alternative_barcodes":{"anyOf":[{"items":{"$ref":"#/components/schemas/UpdateBarcodeInput"},"type":"array"},{"type":"null"}],"title":"Alternative Barcodes"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id"}},"type":"object","title":"HandlingUnitUpdateData"}},"components/schemas/HazchemConsignmentInput":{"id":"components/schemas/HazchemConsignmentInput","kind":"json-schema","title":"HazchemConsignmentInput","data":{"properties":{"consignment_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Consignment Number"},"tracking_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tracking Code"}},"type":"object","title":"HazchemConsignmentInput"}},"components/schemas/ImportConfiguration":{"id":"components/schemas/ImportConfiguration","kind":"json-schema","title":"ImportConfiguration","data":{"properties":{"code":{"type":"string","title":"Code","description":"Import source in Qargo to route the order uploads to","default":"API"}},"type":"object","title":"ImportConfiguration"}},"components/schemas/ImportDeclarationTypeEnum":{"id":"components/schemas/ImportDeclarationTypeEnum","kind":"json-schema","title":"ImportDeclarationTypeEnum","data":{"type":"string","enum":["IM"],"title":"ImportDeclarationTypeEnum"}},"components/schemas/ImportExportExtraFields":{"id":"components/schemas/ImportExportExtraFields","kind":"json-schema","title":"ImportExportExtraFields","data":{"properties":{"incoterm":{"anyOf":[{"$ref":"#/components/schemas/Incoterm"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Incoterm for the order. The available incoterms are:"},"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":"code","inline":true,"attributes":{"content":"EXW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Ex Works"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FCA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Free Carrier"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Free Alongside Ship"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FOB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Free On Board"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CFR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Cost and Freight"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CIF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Cost, Insurance and Freight"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CPT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Carriage Paid To"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CIP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Carriage and Insurance Paid To"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DAP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Delivered At Place"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DPU"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Delivered At Place Unloaded / Delivered at Terminal (DAT)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DDP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Delivered Duty Paid"},"children":[]}]}]}]}]},"destination_country_of_goods":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Destination Country Of Goods","description":"Destination country of goods in ISO 3166-1 alpha-2 format","examples":["BE","FR"]},"origin_country_of_goods":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Origin Country Of Goods","description":"Origin country of goods in ISO 3166-1 alpha-2 format","examples":["BE","FR"]}},"type":"object","title":"ImportExportExtraFields"}},"components/schemas/ImportExportInput":{"id":"components/schemas/ImportExportInput","kind":"json-schema","title":"ImportExportInput","data":{"properties":{"hs_code_import":{"anyOf":[{"$ref":"#/components/schemas/HSCodeField"},{"type":"null"}]},"hs_code_export":{"anyOf":[{"$ref":"#/components/schemas/HSCodeField"},{"type":"null"}]},"commercial_invoice":{"anyOf":[{"$ref":"#/components/schemas/CommercialInvoiceInput"},{"type":"null"}]}},"type":"object","title":"ImportExportInput"}},"components/schemas/Incident":{"id":"components/schemas/Incident","kind":"json-schema","title":"Incident","data":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Human readable identifier"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Machine readable identifier"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Description of the incident"},"custom_fields":{"type":"object","title":"Custom Fields","description":"Store values for user defined fields"}},"type":"object","title":"Incident"}},"components/schemas/Incoterm":{"id":"components/schemas/Incoterm","kind":"json-schema","title":"Incoterm","data":{"type":"string","enum":["EXW","FCA","FAS","FOB","CFR","CIF","CPT","CIP","DAP","DPU","DDP"],"title":"Incoterm"}},"components/schemas/IntermodalBookingPayload":{"id":"components/schemas/IntermodalBookingPayload","kind":"json-schema","title":"IntermodalBookingPayload","data":{"properties":{"trip":{"$ref":"#/components/schemas/BookingTrip","description":"Qargo Trip the booking belongs to"},"orders":{"items":{"$ref":"#/components/schemas/OrderOutput-Input"},"type":"array","title":"Orders"},"booking":{"$ref":"#/components/schemas/Booking"},"trip_name":{"type":"string","title":"Trip Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Qargo Trip name. Replaced by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trip.name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", please use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trip.name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}],"deprecated":true}},"type":"object","required":["trip_name","trip","orders","booking"],"title":"IntermodalBookingPayload"}},"components/schemas/IntermodalBookingPushPayload":{"id":"components/schemas/IntermodalBookingPushPayload","kind":"json-schema","title":"IntermodalBookingPushPayload","data":{"properties":{"operation":{"$ref":"#/components/schemas/BookingOperation"},"payload":{"$ref":"#/components/schemas/IntermodalBookingPayload"},"account_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Code"}},"type":"object","required":["operation","payload","account_code"],"title":"IntermodalBookingPushPayload"}},"components/schemas/IntermodalBookingReferences":{"id":"components/schemas/IntermodalBookingReferences","kind":"json-schema","title":"IntermodalBookingReferences","data":{"properties":{"arrival_reference_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Arrival Reference Number","description":"Booking reference for the arrival conveyance at the port of discharge."},"departure_reference_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Departure Reference Number","description":"Booking reference for the departure conveyance at the port of loading."}},"type":"object","title":"IntermodalBookingReferences"}},"components/schemas/IntermodalBookingStatusPayload":{"id":"components/schemas/IntermodalBookingStatusPayload","kind":"json-schema","title":"IntermodalBookingStatusPayload","data":{"properties":{"updates":{"items":{"$ref":"#/components/schemas/IntermodalBookingUpdate"},"type":"array","title":"Updates"}},"type":"object","required":["updates"],"title":"IntermodalBookingStatusPayload"}},"components/schemas/IntermodalBookingUpdate":{"id":"components/schemas/IntermodalBookingUpdate","kind":"json-schema","title":"IntermodalBookingUpdate","data":{"properties":{"match":{"anyOf":[{"$ref":"#/components/schemas/BookingMatchTarget"},{"type":"null"}],"description":"Matching criteria to match the booking in Qargo"},"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"ID of the booking in Qargo"},"event_time":{"type":"string","format":"date-time","title":"Event Time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time of the event (ISO 8601 format with a timezone offset, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+02:00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"default":"2026-09-11T06:56:12.327308","examples":["2024-12-31T08:00:00Z"]},"status":{"anyOf":[{"$ref":"#/components/schemas/IntermodalStatuses"},{"type":"null"}],"description":"Status update for the booking."},"stop_timestamps":{"anyOf":[{"$ref":"#/components/schemas/IntermodalStopTimestampsGroup"},{"type":"null"}],"description":"Estimated and actual timestamps for the booking's departure and arrival stops. Whether these timestamps are applied depends on the integration's configuration in Qargo; they are ignored unless stop-time syncing is enabled for the integration."},"booking_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Booking Reference","description":"Operator's booking reference. Reference is filled in here, the field itself is not used to match the booking in Qargo."},"references":{"anyOf":[{"$ref":"#/components/schemas/IntermodalBookingReferences"},{"type":"null"}],"description":"Per-port booking references for the arrival and departure conveyances."},"skip_dispatch":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Skip Dispatch","description":"Marks the booking as final. Prevents further updates from being sent when the booking is updated in Qargo."},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the booking in your own system. When supplied, Qargo stores it as the identifier for this booking, taking precedence over "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"booking_reference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The value is only recorded on updates that also carry "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"booking_reference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or set the status to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BOOKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"booking_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Booking Id","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique technical Qargo id for the booking. Replaced by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", please use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}],"deprecated":true},"timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time of the event. Replaced by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", please use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}],"deprecated":true}},"type":"object","title":"IntermodalBookingUpdate"}},"components/schemas/IntermodalBookingsPushPayload":{"id":"components/schemas/IntermodalBookingsPushPayload","kind":"json-schema","title":"IntermodalBookingsPushPayload","data":{"properties":{"operations":{"items":{"$ref":"#/components/schemas/IntermodalBookingPushPayload"},"type":"array","title":"Operations"}},"type":"object","required":["operations"],"title":"IntermodalBookingsPushPayload"}},"components/schemas/IntermodalExecutionStatus":{"id":"components/schemas/IntermodalExecutionStatus","kind":"json-schema","title":"IntermodalExecutionStatus","data":{"properties":{"event_time":{"type":"string","format":"date-time","title":"Event Time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time of the event (ISO 8601 format with a timezone offset, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+02:00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"examples":["2024-12-31T08:00:00Z"]},"ok":{"type":"boolean","title":"Ok","description":"Is the status ok"},"type":{"anyOf":[{"type":"string"},{"$ref":"#/components/schemas/IntermodalExecutionStatusEnum"}],"title":"Type","description":"Type of the status"},"remark":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remark","description":"extra remark about the status"}},"type":"object","required":["event_time","ok","type"],"title":"IntermodalExecutionStatus"}},"components/schemas/IntermodalExecutionStatusEnum":{"id":"components/schemas/IntermodalExecutionStatusEnum","kind":"json-schema","title":"IntermodalExecutionStatusEnum","data":{"type":"string","enum":["GATE_IN","CLEARED_CUSTOMS","CHECKED_IN","ON_BOARD","DEPARTED","ARRIVED","DISCHARGED","GATE_OUT"],"title":"IntermodalExecutionStatusEnum"}},"components/schemas/IntermodalStatuses":{"id":"components/schemas/IntermodalStatuses","kind":"json-schema","title":"IntermodalStatuses","data":{"properties":{"booking_status":{"anyOf":[{"$ref":"#/components/schemas/BookingStatus"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lifecycle status of the booking request: whether it is being processed, accepted, or rejected. At least one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"booking_status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"execution_statuses"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failure"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be set."},"children":[]}]}]}]},"execution_statuses":{"anyOf":[{"items":{"$ref":"#/components/schemas/IntermodalExecutionStatus"},"type":"array"},{"type":"null"}],"title":"Execution Statuses","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operational movement statuses reported during execution, in chronological order. At least one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"booking_status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"execution_statuses"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failure"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be set."},"children":[]}]}]}]},"failure":{"anyOf":[{"$ref":"#/components/schemas/ErrorStatus"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error details when the booking request could not be processed. At least one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"booking_status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"execution_statuses"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failure"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be set."},"children":[]}]}]}]}},"type":"object","title":"IntermodalStatuses"}},"components/schemas/IntermodalStopTimestamps":{"id":"components/schemas/IntermodalStopTimestamps","kind":"json-schema","title":"IntermodalStopTimestamps","data":{"properties":{"eta_timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Eta Timestamp","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Estimated time of arrival at the stop (ISO 8601 format with a timezone offset, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+02:00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"examples":["2024-12-31T08:00:00Z"]},"actual_start_timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Actual Start Timestamp","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Actual time the stop started (arrival at the stop - ISO 8601 format with a timezone offset, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+02:00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"examples":["2024-12-31T08:00:00Z"]},"actual_end_timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Actual End Timestamp","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Actual time the stop ended (departure from the stop - ISO 8601 format with a timezone offset, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+02:00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"examples":["2024-12-31T08:00:00Z"]}},"type":"object","title":"IntermodalStopTimestamps"}},"components/schemas/IntermodalStopTimestampsGroup":{"id":"components/schemas/IntermodalStopTimestampsGroup","kind":"json-schema","title":"IntermodalStopTimestampsGroup","data":{"properties":{"departure":{"anyOf":[{"$ref":"#/components/schemas/IntermodalStopTimestamps"},{"type":"null"}],"description":"Timestamps for the departure stop (port of loading)."},"arrival":{"anyOf":[{"$ref":"#/components/schemas/IntermodalStopTimestamps"},{"type":"null"}],"description":"Timestamps for the arrival stop (port of discharge)."}},"type":"object","title":"IntermodalStopTimestampsGroup"}},"components/schemas/InvoiceStatus":{"id":"components/schemas/InvoiceStatus","kind":"json-schema","title":"InvoiceStatus","data":{"type":"string","enum":["DRAFT","PRE_INVOICED","INVOICED","INVOICE_POSTED"],"title":"InvoiceStatus","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status description:"},"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":"DRAFT: Invoice is in draft state and not yet invoiced."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PRE_INVOICED: Invoice is in pre-invoiced state and not yet invoiced (Purchase invoice only)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INVOICED: Invoice is invoiced but not yet posted."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INVOICE_POSTED: Invoice is invoiced and posted."},"children":[]}]}]}]}]}},"components/schemas/KuehneNagelExtraFields":{"id":"components/schemas/KuehneNagelExtraFields","kind":"json-schema","title":"KuehneNagelExtraFields","data":{"properties":{"sender_depot_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sender Depot Code","description":"Sender depot code"},"receiver_depot_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receiver Depot Code","description":"Receiver depot code"}},"type":"object","title":"KuehneNagelExtraFields"}},"components/schemas/LegMatch":{"id":"components/schemas/LegMatch","kind":"json-schema","title":"LegMatch","data":{"properties":{"leg_type":{"anyOf":[{"$ref":"#/components/schemas/LegType"},{"type":"null"}]}},"type":"object","title":"LegMatch"}},"components/schemas/LegType":{"id":"components/schemas/LegType","kind":"json-schema","title":"LegType","data":{"type":"string","enum":["PICKUP","TRANSFER","DELIVERY","DIRECT","EMPTY"],"title":"LegType"}},"components/schemas/LineItem":{"id":"components/schemas/LineItem","kind":"json-schema","title":"LineItem","data":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"Unique id of this line item. A Qargo invoice line can be represented with multiple LineItems if revenue/cost split is enabled."},"invoice_line_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Invoice Line Id","description":"Technical id of the invoice within the Qargo system"},"name":{"type":"string","title":"Name","description":"Name of the charge line.","examples":["Fuel charge"]},"amount":{"type":"string","title":"Amount","description":"Amount of the charge line.","examples":["100"]},"code":{"type":"string","title":"Code","description":"Code of the type of charge line.","examples":["FUEL"]},"account":{"anyOf":[{"$ref":"#/components/schemas/api__order__models__charge__AccountOutput"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Freeform description field","default":"","examples":["Charge description"]},"tax_rate":{"anyOf":[{"$ref":"#/components/schemas/api__accounting__models__invoice__TaxRate"},{"type":"null"}]},"base_tax_rate":{"anyOf":[{"$ref":"#/components/schemas/BaseTaxRate"},{"type":"null"}],"description":"Original tax rate before applying tax rules."},"order_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Order Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the Qargo order linked to this line item. For purchase invoices, this is an empty string when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":["Order-0001"]},"order_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Order Id","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the Qargo order linked to this line item. For purchase invoices, this is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when charges are not calculated per order and the line item is not split per order."},"children":[]}]}]}]},"trip_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Trip Id","description":"Linked Qargo trip id, for cost charges"},"is_credit_charge":{"type":"boolean","title":"Is Credit Charge","default":false,"examples":[false]},"invoice_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Name","description":"Name of the source invoice this line item is linked to, if applicable.","examples":["Invoice-0001"]},"currency":{"type":"string","title":"Currency","examples":["USD"]},"fraction":{"type":"string","title":"Fraction","description":"The api can split the charge lines according to revenue. This fraction indicates the percentage of the total amount of the split for this set of dimensions.","default":"1","examples":["0.5"]},"dimension_1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dimension 1"},"dimension_2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dimension 2"},"dimension_3":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dimension 3"},"dimension_4":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dimension 4"},"dimension_5":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dimension 5"},"dimension_6":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dimension 6"}},"type":"object","required":["id","invoice_line_id","name","amount","code","currency"],"title":"LineItem","description":"Represents a single invoice/credit line item.\n\nNote that a single invoice line can be split up in multiple line items\nif revenue split is enabled."}},"components/schemas/ListAccountOutput":{"id":"components/schemas/ListAccountOutput","kind":"json-schema","title":"ListAccountOutput","data":{"properties":{"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"},"items":{"items":{"$ref":"#/components/schemas/api__accounting__models__master_data__AccountOutput"},"type":"array","title":"Items"}},"type":"object","required":["items"],"title":"ListAccountOutput"}},"components/schemas/ListCompanyDocumentOutput":{"id":"components/schemas/ListCompanyDocumentOutput","kind":"json-schema","title":"ListCompanyDocumentOutput","data":{"properties":{"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"},"items":{"items":{"$ref":"#/components/schemas/CompanyDocumentOutput"},"type":"array","title":"Items"}},"type":"object","required":["items"],"title":"ListCompanyDocumentOutput"}},"components/schemas/ListCompanyOutput":{"id":"components/schemas/ListCompanyOutput","kind":"json-schema","title":"ListCompanyOutput","data":{"properties":{"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"},"items":{"items":{"$ref":"#/components/schemas/CompanyDetailOutput"},"type":"array","title":"Items"}},"type":"object","required":["items"],"title":"ListCompanyOutput"}},"components/schemas/ListCompanyValidityOutput":{"id":"components/schemas/ListCompanyValidityOutput","kind":"json-schema","title":"ListCompanyValidityOutput","data":{"properties":{"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"},"items":{"items":{"$ref":"#/components/schemas/CompanyValidityOutput"},"type":"array","title":"Items"}},"type":"object","required":["items"],"title":"ListCompanyValidityOutput"}},"components/schemas/ListExchangeRateOutput":{"id":"components/schemas/ListExchangeRateOutput","kind":"json-schema","title":"ListExchangeRateOutput","data":{"properties":{"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"},"items":{"items":{"$ref":"#/components/schemas/ExchangeRateOutput"},"type":"array","title":"Items"}},"type":"object","required":["items"],"title":"ListExchangeRateOutput"}},"components/schemas/ListLocationOutput":{"id":"components/schemas/ListLocationOutput","kind":"json-schema","title":"ListLocationOutput","data":{"properties":{"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"},"items":{"items":{"$ref":"#/components/schemas/LocationDetailOutput"},"type":"array","title":"Items"}},"type":"object","required":["items"],"title":"ListLocationOutput"}},"components/schemas/ListResourceGroupOutput":{"id":"components/schemas/ListResourceGroupOutput","kind":"json-schema","title":"ListResourceGroupOutput","data":{"properties":{"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"},"items":{"items":{"$ref":"#/components/schemas/ResourceGroupOutput"},"type":"array","title":"Items"}},"type":"object","required":["items"],"title":"ListResourceGroupOutput"}},"components/schemas/ListResourceOutput":{"id":"components/schemas/ListResourceOutput","kind":"json-schema","title":"ListResourceOutput","data":{"properties":{"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"},"items":{"items":{"anyOf":[{"$ref":"#/components/schemas/DriverResourceOutput"},{"$ref":"#/components/schemas/TractorResourceOutput"},{"$ref":"#/components/schemas/TruckResourceOutput"},{"$ref":"#/components/schemas/VanResourceOutput"},{"$ref":"#/components/schemas/TrailerResourceOutput"},{"$ref":"#/components/schemas/FullTrailerResourceOutput"},{"$ref":"#/components/schemas/ChassisResourceOutput"},{"$ref":"#/components/schemas/ContainerResourceOutput"}]},"type":"array","title":"Items"}},"type":"object","required":["items"],"title":"ListResourceOutput"}},"components/schemas/ListResourceUnavailabilityOutput":{"id":"components/schemas/ListResourceUnavailabilityOutput","kind":"json-schema","title":"ListResourceUnavailabilityOutput","data":{"properties":{"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"},"items":{"items":{"$ref":"#/components/schemas/ResourceUnavailabilityOutput"},"type":"array","title":"Items"}},"type":"object","required":["items"],"title":"ListResourceUnavailabilityOutput"}},"components/schemas/ListResourceValidityOutput":{"id":"components/schemas/ListResourceValidityOutput","kind":"json-schema","title":"ListResourceValidityOutput","data":{"properties":{"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"},"items":{"items":{"$ref":"#/components/schemas/ResourceValidityOutput"},"type":"array","title":"Items"}},"type":"object","required":["items"],"title":"ListResourceValidityOutput"}},"components/schemas/ListTaxRateOutput":{"id":"components/schemas/ListTaxRateOutput","kind":"json-schema","title":"ListTaxRateOutput","data":{"properties":{"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"},"items":{"items":{"$ref":"#/components/schemas/TaxRateOutput"},"type":"array","title":"Items"}},"type":"object","required":["items"],"title":"ListTaxRateOutput"}},"components/schemas/Location":{"id":"components/schemas/Location","kind":"json-schema","title":"Location","data":{"properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Technical code for integrations/mapping logic; should be treated as stable once set.","examples":["LOC123"]},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name","description":"Human-readable label for a location in operational views.","examples":["Main Office"]},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":"Identifier from an external (master data) system."},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address","description":"First address line of the location","examples":["Gaston Crommenlaan 4"]},"address_second_line":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address Second Line","description":"Second address line of the location","examples":[""]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City of the location","examples":["Ghent"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State of the location","examples":[""]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code (ISO 3166-1 alpha-2) of the location","examples":["BE"]},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Postal Code","description":"Postal code of the location","examples":["9050"]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the location","examples":["Qargo HQ"]},"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"Identifier of the location"},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Latitude"},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Longitude"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Location description"},"location_identifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location Identifier","description":"External location identifier"}},"type":"object","title":"Location"}},"components/schemas/LocationBookingDispatchResponse":{"id":"components/schemas/LocationBookingDispatchResponse","kind":"json-schema","title":"LocationBookingDispatchResponse","data":{"properties":{"errors":{"anyOf":[{"items":{"$ref":"#/components/schemas/ErrorStatus"},"type":"array"},{"type":"null"}],"title":"Errors","description":"List of errors that occurred during the webhook processing. If empty/omitted, the webhook was processed successfully.","examples":[{"error_message":"The payload is invalid.","error_type":"USER_INPUT_ERROR"},{"error_message":"Not supported.","error_type":"NOT_SUPPORTED"},{"error_message":"Unknown error.","error_type":"INTERNAL_ERROR"}]}},"type":"object","title":"LocationBookingDispatchResponse","description":"Response schema for the location booking dispatch payload.\nThis schema is used to return errors or success messages."}},"components/schemas/LocationBookingPayload":{"id":"components/schemas/LocationBookingPayload","kind":"json-schema","title":"LocationBookingPayload","data":{"properties":{"booking_id":{"type":"string","format":"uuid","title":"Booking Id","description":"Unique technical Qargo id for the booking"},"booking_name":{"type":"string","title":"Booking Name","description":"Qargo Name of the booking, used for human readable reference"},"location":{"$ref":"#/components/schemas/LocationOutput","description":"Geographical location of the location booking"},"stops":{"items":{"$ref":"#/components/schemas/StopOutput-Input"},"type":"array","title":"Stops","description":"List of relevant stops for the location booking"},"resource_allocations":{"anyOf":[{"items":{"$ref":"#/components/schemas/DispatchResourceAllocation"},"type":"array"},{"type":"null"}],"title":"Resource Allocations","description":"List of resources allocated to the location booking"},"trailer":{"anyOf":[{"$ref":"#/components/schemas/Trailer"},{"type":"null"}],"description":"Trailer used in the location booking","deprecated":true},"vehicle":{"anyOf":[{"$ref":"#/components/schemas/Vehicle"},{"type":"null"}],"description":"Vehicle used in the location booking","deprecated":true}},"type":"object","required":["booking_id","booking_name","location"],"title":"LocationBookingPayload"}},"components/schemas/LocationBookingTripSummary":{"id":"components/schemas/LocationBookingTripSummary","kind":"json-schema","title":"LocationBookingTripSummary","data":{"properties":{"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"Custom fields associated with the trip"},"estimated_start_timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Estimated Start Timestamp","description":"Estimated start time of the trip"}},"type":"object","title":"LocationBookingTripSummary"}},"components/schemas/LocationBookingUpdate":{"id":"components/schemas/LocationBookingUpdate","kind":"json-schema","title":"LocationBookingUpdate","data":{"properties":{"match":{"anyOf":[{"$ref":"#/components/schemas/BookingMatchTarget"},{"type":"null"}],"description":"Matching criteria to match the booking in Qargo"},"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"ID of the booking in Qargo"},"event_time":{"type":"string","format":"date-time","title":"Event Time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time of the event (ISO 8601 format with a timezone offset, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+02:00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"default":"2026-09-11T06:56:12.327308","examples":["2024-12-31T08:00:00Z"]},"execution_status":{"anyOf":[{"$ref":"#/components/schemas/ExecutionStatusUpdate"},{"type":"null"}],"description":"Execution status updates"},"status":{"anyOf":[{"$ref":"#/components/schemas/BookingStatus"},{"type":"null"}],"description":"New status of the location booking"},"question_answers":{"type":"object","title":"Question Answers","description":"Question answers to update on the order. Mapping is configured in Qargo"}},"type":"object","title":"LocationBookingUpdate"}},"components/schemas/LocationBookingUpdatePayload":{"id":"components/schemas/LocationBookingUpdatePayload","kind":"json-schema","title":"LocationBookingUpdatePayload","data":{"properties":{"updates":{"items":{"$ref":"#/components/schemas/LocationBookingUpdate"},"type":"array","title":"Updates"}},"type":"object","required":["updates"],"title":"LocationBookingUpdatePayload"}},"components/schemas/LocationBookingUpdateResponse":{"id":"components/schemas/LocationBookingUpdateResponse","kind":"json-schema","title":"LocationBookingUpdateResponse","data":{"properties":{"errors":{"anyOf":[{"items":{"$ref":"#/components/schemas/ErrorStatus"},"type":"array"},{"type":"null"}],"title":"Errors","description":"List of errors that occurred during the webhook processing. If empty/omitted, the webhook was processed successfully.","examples":[{"error_message":"The payload is invalid.","error_type":"USER_INPUT_ERROR"},{"error_message":"Not supported.","error_type":"NOT_SUPPORTED"},{"error_message":"Unknown error.","error_type":"INTERNAL_ERROR"}]}},"type":"object","title":"LocationBookingUpdateResponse","description":"Response schema for the location booking update webhook.\nThis schema is used to return errors or success messages."}},"components/schemas/LocationDetailInput":{"id":"components/schemas/LocationDetailInput","kind":"json-schema","title":"LocationDetailInput","data":{"properties":{"latitude":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Latitude","description":"Latitude of the location. When omitted on create, the coordinates are geocoded from the address.","examples":[51.0543]},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Longitude","description":"Longitude of the location. When omitted on create, the coordinates are geocoded from the address.","examples":[3.7174]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Free-text description of the location."},"selectable_on_customer_portal":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Selectable On Customer Portal","description":"Whether the location can be selected on the customer portal."},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Technical code for integrations/mapping logic; should be treated as stable once set.","examples":["LOC123"]},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name","description":"Human-readable label for a location in operational views.","examples":["Main Office"]},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":"Identifier from an external (master data) system."},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address","description":"First address line of the location","examples":["Gaston Crommenlaan 4"]},"address_second_line":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address Second Line","description":"Second address line of the location","examples":[""]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City of the location","examples":["Ghent"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State of the location","examples":[""]},"country":{"type":"string","title":"Country","description":"Country code (ISO 3166-1 alpha-2) of the location","examples":["BE"]},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Postal Code","description":"Postal code of the location","examples":["9050"]},"name":{"type":"string","title":"Name","description":"Name of the location.","examples":["Ghent Warehouse"]},"opening_hours":{"anyOf":[{"$ref":"#/components/schemas/WeekScheduleInput"},{"type":"null"}],"description":"Weekly opening hours for all seven days. Replaces the full schedule when provided."}},"type":"object","required":["country","name"],"title":"LocationDetailInput"}},"components/schemas/LocationDetailOutput":{"id":"components/schemas/LocationDetailOutput","kind":"json-schema","title":"LocationDetailOutput","data":{"properties":{"latitude":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Latitude","description":"Latitude of the location.","examples":[51.0543]},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Longitude","description":"Longitude of the location.","examples":[3.7174]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Free-text description of the location."},"selectable_on_customer_portal":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Selectable On Customer Portal","description":"Whether the location can be selected on the customer portal."},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Technical code for integrations/mapping logic; should be treated as stable once set.","examples":["LOC123"]},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name","description":"Human-readable label for a location in operational views.","examples":["Main Office"]},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":"Identifier from an external (master data) system."},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address","description":"First address line of the location","examples":["Gaston Crommenlaan 4"]},"address_second_line":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address Second Line","description":"Second address line of the location","examples":[""]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City of the location","examples":["Ghent"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State of the location","examples":[""]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code (ISO 3166-1 alpha-2) of the location","examples":["BE"]},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Postal Code","description":"Postal code of the location","examples":["9050"]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the location","examples":["Qargo HQ"]},"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"Unique identifier of the location."},"opening_hours":{"anyOf":[{"$ref":"#/components/schemas/WeekSchedule"},{"type":"null"}],"description":"Weekly opening hours."}},"type":"object","title":"LocationDetailOutput"}},"components/schemas/LocationDispatchOutput":{"id":"components/schemas/LocationDispatchOutput","kind":"json-schema","title":"LocationDispatchOutput","data":{"properties":{"operation":{"$ref":"#/components/schemas/BookingOperation"},"payload":{"$ref":"#/components/schemas/LocationDispatchPayload"}},"type":"object","required":["operation","payload"],"title":"LocationDispatchOutput"}},"components/schemas/LocationDispatchPayload":{"id":"components/schemas/LocationDispatchPayload","kind":"json-schema","title":"LocationDispatchPayload","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"ID of the trip"},"name":{"type":"string","title":"Name","description":"Name of the trip, used for human readable reference"},"orders":{"items":{"$ref":"#/components/schemas/DispatchOrderOutput"},"type":"array","title":"Orders"},"scenario":{"$ref":"#/components/schemas/LocationScenario"},"booking":{"$ref":"#/components/schemas/LocationBookingPayload"},"trip_summary":{"anyOf":[{"$ref":"#/components/schemas/LocationBookingTripSummary"},{"type":"null"}],"description":"Summary information about the trip"}},"type":"object","required":["id","name","scenario","booking"],"title":"LocationDispatchPayload"}},"components/schemas/LocationInput":{"id":"components/schemas/LocationInput","kind":"json-schema","title":"LocationInput","data":{"properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address"},"address_second_line":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address Second Line"},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Postal Code"},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State"},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country"},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Latitude"},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Longitude"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"location_identifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location Identifier"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id"},"location_search":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location Search"},"place_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Place Id"}},"type":"object","title":"LocationInput"}},"components/schemas/LocationOutput":{"id":"components/schemas/LocationOutput","kind":"json-schema","title":"LocationOutput","data":{"properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Technical code for integrations/mapping logic; should be treated as stable once set.","examples":["LOC123"]},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name","description":"Human-readable label for a location in operational views.","examples":["Main Office"]},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":"Identifier from an external (master data) system."},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address","description":"First address line of the location","examples":["Gaston Crommenlaan 4"]},"address_second_line":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address Second Line","description":"Second address line of the location","examples":[""]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City of the location","examples":["Ghent"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State of the location","examples":[""]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code (ISO 3166-1 alpha-2) of the location","examples":["BE"]},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Postal Code","description":"Postal code of the location","examples":["9050"]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the location","examples":["Qargo HQ"]},"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"Unique identifier of the location"},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Latitude","description":"Latitude of the location"},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Longitude","description":"Longitude of the location"}},"type":"object","title":"LocationOutput"}},"components/schemas/LocationReference":{"id":"components/schemas/LocationReference","kind":"json-schema","title":"LocationReference","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Identifier of the location"}},"type":"object","required":["id"],"title":"LocationReference"}},"components/schemas/LocationScenario":{"id":"components/schemas/LocationScenario","kind":"json-schema","title":"LocationScenario","data":{"type":"string","enum":["INBOUND","OUTBOUND","INBOUND_OUTBOUND"],"title":"LocationScenario"}},"components/schemas/LocationWithTerminalOutput-Input":{"id":"components/schemas/LocationWithTerminalOutput-Input","kind":"json-schema","title":"LocationWithTerminalOutput","data":{"properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Technical code for integrations/mapping logic; should be treated as stable once set.","examples":["LOC123"]},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name","description":"Human-readable label for a location in operational views.","examples":["Main Office"]},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":"Identifier from an external (master data) system."},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address","description":"First address line of the location","examples":["Gaston Crommenlaan 4"]},"address_second_line":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address Second Line","description":"Second address line of the location","examples":[""]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City of the location","examples":["Ghent"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State of the location","examples":[""]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code (ISO 3166-1 alpha-2) of the location","examples":["BE"]},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Postal Code","description":"Postal code of the location","examples":["9050"]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the location","examples":["Qargo HQ"]},"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"Unique identifier of the location"},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Latitude","description":"Latitude of the location"},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Longitude","description":"Longitude of the location"},"terminal_metadata":{"anyOf":[{"$ref":"#/components/schemas/TerminalMetadata"},{"type":"null"}],"description":"Metadata related to the terminal"},"customs_metadata":{"anyOf":[{"$ref":"#/components/schemas/CustomsMetadata"},{"type":"null"}],"description":"Metadata related to customs"}},"type":"object","title":"LocationWithTerminalOutput"}},"components/schemas/LocationWithTerminalOutput-Output":{"id":"components/schemas/LocationWithTerminalOutput-Output","kind":"json-schema","title":"LocationWithTerminalOutput","data":{"properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Technical code for integrations/mapping logic; should be treated as stable once set.","examples":["LOC123"]},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name","description":"Human-readable label for a location in operational views.","examples":["Main Office"]},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":"Identifier from an external (master data) system."},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address","description":"First address line of the location","examples":["Gaston Crommenlaan 4"]},"address_second_line":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address Second Line","description":"Second address line of the location","examples":[""]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City of the location","examples":["Ghent"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State of the location","examples":[""]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code (ISO 3166-1 alpha-2) of the location","examples":["BE"]},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Postal Code","description":"Postal code of the location","examples":["9050"]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the location","examples":["Qargo HQ"]},"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"Unique identifier of the location"},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Latitude","description":"Latitude of the location"},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Longitude","description":"Longitude of the location"},"terminal_metadata":{"anyOf":[{"$ref":"#/components/schemas/TerminalMetadata"},{"type":"null"}],"description":"Metadata related to the terminal"},"customs_metadata":{"anyOf":[{"$ref":"#/components/schemas/CustomsMetadata"},{"type":"null"}],"description":"Metadata related to customs"}},"type":"object","title":"LocationWithTerminalOutput"}},"components/schemas/ManuportOrderInput":{"id":"components/schemas/ManuportOrderInput","kind":"json-schema","title":"ManuportOrderInput","data":{"properties":{"delivery_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Delivery Number"},"seal_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Seal Number"},"order_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Order Number"},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Id"},"sender_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sender Id"}},"type":"object","title":"ManuportOrderInput"}},"components/schemas/MinimalOrderOutput":{"id":"components/schemas/MinimalOrderOutput","kind":"json-schema","title":"MinimalOrderOutput","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"ID of the order"},"name":{"type":"string","title":"Name","description":"Name of the order"}},"type":"object","required":["id","name"],"title":"MinimalOrderOutput"}},"components/schemas/OperationEnum":{"id":"components/schemas/OperationEnum","kind":"json-schema","title":"OperationEnum","data":{"type":"string","enum":["CREATE","UPDATE","DELETE"],"title":"OperationEnum"}},"components/schemas/OperationalVisibilityUpdate":{"id":"components/schemas/OperationalVisibilityUpdate","kind":"json-schema","title":"OperationalVisibilityUpdate","data":{"properties":{"events":{"items":{"$ref":"#/components/schemas/VisibilityEvent"},"type":"array","title":"Events","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events tracked in this update. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PositionUpdate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not implemented yet. 🚧"},"children":[]}]}]}]},"order":{"anyOf":[{"$ref":"#/components/schemas/VisibilityOrder"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current state of the order. Included for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OrderUpdate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"StopUpdate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DocumentUpdate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EtaUpdate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HandlingUnitUpdate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" events. Never included together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the same event."},"children":[]}]}]}]},"trip":{"anyOf":[{"$ref":"#/components/schemas/VisibilityTrip"},{"type":"null"}],"description":"Current state of the trip. This field is not populated by default. Including it requires a custom webhook format configured by Qargo."}},"type":"object","required":["events"],"title":"OperationalVisibilityUpdate"}},"components/schemas/OrderChargesOutput":{"id":"components/schemas/OrderChargesOutput","kind":"json-schema","title":"OrderChargesOutput","data":{"properties":{"charges":{"anyOf":[{"items":{"$ref":"#/components/schemas/ChargeWithApprovalOutput"},"type":"array"},{"type":"null"}],"title":"Charges","description":"List of charges"}},"type":"object","title":"OrderChargesOutput"}},"components/schemas/OrderConsignmentOutput-Input":{"id":"components/schemas/OrderConsignmentOutput-Input","kind":"json-schema","title":"OrderConsignmentOutput","data":{"properties":{"consignment_reference_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Consignment Reference Number","description":"Consignment reference number"},"cmr_reference_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cmr Reference Number"},"planning_instructions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Planning Instructions","description":"Additional freeform instructions for the planner."},"custom_fields":{"type":"object","title":"Custom Fields","description":"Additional user defined fields to fill in"},"transport_network":{"anyOf":[{"$ref":"#/components/schemas/ConsignmentTransportNetwork"},{"type":"null"}],"description":"Transport network"},"central_transport_network":{"anyOf":[{"$ref":"#/components/schemas/CentralTransportNetworkConsignmentExtraFields"},{"type":"null"}]},"palletline":{"anyOf":[{"$ref":"#/components/schemas/PalletlineConsignmentExtraFields"},{"type":"null"}]},"palletforce":{"anyOf":[{"$ref":"#/components/schemas/PalletforceConsignmentExtraFields"},{"type":"null"}]},"transporeon":{"anyOf":[{"$ref":"#/components/schemas/TransporeonConsignmentExtraFields"},{"type":"null"}]},"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier of the consignment"},"pickup_stop":{"$ref":"#/components/schemas/StopOutput-Input","description":"First stop on this consignment."},"delivery_stop":{"$ref":"#/components/schemas/StopOutput-Input","description":"Last stop on this consignment."},"goods":{"anyOf":[{"items":{"$ref":"#/components/schemas/GoodOutput-Input"},"type":"array"},{"type":"null"}],"title":"Goods"},"signatures":{"items":{"$ref":"#/components/schemas/Signature"},"type":"array","title":"Signatures","description":"List of signatures related to the consignment"},"import_export":{"anyOf":[{"$ref":"#/components/schemas/ConsignmentImportExportExtraFieldsOutput-Input"},{"type":"null"}]},"buyer":{"anyOf":[{"$ref":"#/components/schemas/ConsignmentBuyerSellerOutput-Input"},{"type":"null"}],"description":"Buyer information for this consignment"},"seller":{"anyOf":[{"$ref":"#/components/schemas/ConsignmentBuyerSellerOutput-Input"},{"type":"null"}],"description":"Seller information for this consignment"},"tracking_link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tracking Link","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public tracking page URL for this consignment. Returned on the tenant API only: always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for customer portal callers. Also "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the consignment has no tracking link, for example when the tracking link integration is not enabled on the tenant or the link has been revoked."},"children":[]}]}]}]}},"type":"object","required":["id","pickup_stop","delivery_stop"],"title":"OrderConsignmentOutput"}},"components/schemas/OrderConsignmentOutput-Output":{"id":"components/schemas/OrderConsignmentOutput-Output","kind":"json-schema","title":"OrderConsignmentOutput","data":{"properties":{"consignment_reference_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Consignment Reference Number","description":"Consignment reference number"},"cmr_reference_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cmr Reference Number"},"planning_instructions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Planning Instructions","description":"Additional freeform instructions for the planner."},"custom_fields":{"type":"object","title":"Custom Fields","description":"Additional user defined fields to fill in"},"transport_network":{"anyOf":[{"$ref":"#/components/schemas/ConsignmentTransportNetwork"},{"type":"null"}],"description":"Transport network"},"central_transport_network":{"anyOf":[{"$ref":"#/components/schemas/CentralTransportNetworkConsignmentExtraFields"},{"type":"null"}]},"palletline":{"anyOf":[{"$ref":"#/components/schemas/PalletlineConsignmentExtraFields"},{"type":"null"}]},"palletforce":{"anyOf":[{"$ref":"#/components/schemas/PalletforceConsignmentExtraFields"},{"type":"null"}]},"transporeon":{"anyOf":[{"$ref":"#/components/schemas/TransporeonConsignmentExtraFields"},{"type":"null"}]},"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier of the consignment"},"pickup_stop":{"$ref":"#/components/schemas/StopOutput-Output","description":"First stop on this consignment."},"delivery_stop":{"$ref":"#/components/schemas/StopOutput-Output","description":"Last stop on this consignment."},"goods":{"anyOf":[{"items":{"$ref":"#/components/schemas/GoodOutput-Output"},"type":"array"},{"type":"null"}],"title":"Goods"},"signatures":{"items":{"$ref":"#/components/schemas/Signature"},"type":"array","title":"Signatures","description":"List of signatures related to the consignment"},"import_export":{"anyOf":[{"$ref":"#/components/schemas/ConsignmentImportExportExtraFieldsOutput-Output"},{"type":"null"}]},"buyer":{"anyOf":[{"$ref":"#/components/schemas/ConsignmentBuyerSellerOutput-Output"},{"type":"null"}],"description":"Buyer information for this consignment"},"seller":{"anyOf":[{"$ref":"#/components/schemas/ConsignmentBuyerSellerOutput-Output"},{"type":"null"}],"description":"Seller information for this consignment"},"tracking_link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tracking Link","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public tracking page URL for this consignment. Returned on the tenant API only: always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for customer portal callers. Also "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the consignment has no tracking link, for example when the tracking link integration is not enabled on the tenant or the link has been revoked."},"children":[]}]}]}]}},"type":"object","required":["id","pickup_stop","delivery_stop"],"title":"OrderConsignmentOutput"}},"components/schemas/OrderDetailOutput":{"id":"components/schemas/OrderDetailOutput","kind":"json-schema","title":"OrderDetailOutput","data":{"properties":{"transport_service":{"anyOf":[{"$ref":"#/components/schemas/Entity"},{"type":"null"}],"title":"Transport service","description":"Transport service within Qargo"},"customer_reference_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Order reference number from customer"},"service_level":{"anyOf":[{"$ref":"#/components/schemas/ServiceLevel"},{"type":"null"}]},"planning_instructions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Planning Instructions","description":"Additional freeform instructions for the planner."},"department":{"anyOf":[{"$ref":"#/components/schemas/Department"},{"type":"null"}],"description":"Department linked to order"},"neutral_order_type":{"anyOf":[{"type":"string","enum":["NO_NEUTRAL_ORDER","MASK_DELIVERY","MASK_PICKUP"]},{"type":"null"}],"title":"Neutral Order Type","description":"Neutral order"},"container":{"anyOf":[{"$ref":"#/components/schemas/ContainerExtraFields"},{"type":"null"}]},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"User defined additional fields for this order."},"vehicle_category":{"anyOf":[{"$ref":"#/components/schemas/VehicleCategory"},{"type":"null"}],"title":"Vehicle category"},"palletforce":{"anyOf":[{"$ref":"#/components/schemas/PalletforceExtraFields"},{"type":"null"}],"title":"Palletforce specific fields"},"kuehne_nagel":{"anyOf":[{"$ref":"#/components/schemas/KuehneNagelExtraFields"},{"type":"null"}],"title":"Kuehn Nagel specific fields"},"palletline":{"anyOf":[{"$ref":"#/components/schemas/PalletlineExtraFields"},{"type":"null"}],"title":"Palletline specific fields"},"transporeon":{"anyOf":[{"$ref":"#/components/schemas/TransporeonOrderExtraFields"},{"type":"null"}],"title":"Transporeon specific fields"},"dachser":{"anyOf":[{"$ref":"#/components/schemas/DachserExtraFields"},{"type":"null"}],"title":"Dachser specific fields"},"contact_emails":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Contact Emails","description":"List of contact emails to notify about the order"},"import_export":{"anyOf":[{"$ref":"#/components/schemas/ImportExportExtraFields"},{"type":"null"}],"title":"Fields specific to import and export"},"is_consignment_info_validated":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Consignment Info Validated","description":"Flag indicating all consignment information is validated. Customers can only set this to true; only planners (or API/internal callers) can revert it."},"stops":{"anyOf":[{"items":{"$ref":"#/components/schemas/StopOutput-Output"},"type":"array"},{"type":"null"}],"title":"Stops","description":"List of stops in the order, ordered by their sequence"},"order_identifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Order Identifier","description":"Identifier of the order when created from an external source"},"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier for order"},"consignments":{"items":{"$ref":"#/components/schemas/OrderConsignmentOutput-Output"},"type":"array","title":"Consignments"},"pricing":{"anyOf":[{"$ref":"#/components/schemas/OrderPricingOutput"},{"type":"null"}],"description":"Pricing fields related to order"},"customer":{"$ref":"#/components/schemas/CompanyOutput-Output","title":"Customer"},"created_by_user":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By User","description":"User who created the order"},"created_timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created Timestamp","description":"Timestamp of creation"},"start_stop":{"anyOf":[{"$ref":"#/components/schemas/StopOutput-Output"},{"type":"null"}],"description":"First stop on this order"},"end_stop":{"anyOf":[{"$ref":"#/components/schemas/StopOutput-Output"},{"type":"null"}],"description":"Last stop on this order"},"quote_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quote Name","description":"Name of the quote"},"container_load_unload_stop":{"anyOf":[{"$ref":"#/components/schemas/StopOutput-Output"},{"type":"null"}],"title":"Container load/unload stop","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field practically maps to the container yard. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"setup_stops"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (for pick-up) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"teardown_stops"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (for drop-off) are replacing this field, please use them instead."},"children":[]}]}]}],"deprecated":true}},"type":"object","required":["id","consignments","customer"],"title":"OrderDetailOutput"}},"components/schemas/OrderEntityUpdate":{"id":"components/schemas/OrderEntityUpdate","kind":"json-schema","title":"OrderEntityUpdate","data":{"properties":{"operation":{"type":"string","enum":["UPDATE","DELETE"],"title":"Operation"},"data":{"anyOf":[{"$ref":"#/components/schemas/OrderUpdateData"},{"type":"null"}]}},"type":"object","required":["operation"],"title":"OrderEntityUpdate"}},"components/schemas/OrderExport":{"id":"components/schemas/OrderExport","kind":"json-schema","title":"OrderExport","data":{"properties":{"transport_service":{"anyOf":[{"$ref":"#/components/schemas/Entity"},{"type":"null"}],"title":"Transport service","description":"Transport service within Qargo"},"customer_reference_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Order reference number from customer"},"service_level":{"anyOf":[{"$ref":"#/components/schemas/ServiceLevel"},{"type":"null"}]},"planning_instructions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Planning Instructions","description":"Additional freeform instructions for the planner."},"department":{"anyOf":[{"$ref":"#/components/schemas/Department"},{"type":"null"}],"description":"Department linked to order"},"neutral_order_type":{"anyOf":[{"type":"string","enum":["NO_NEUTRAL_ORDER","MASK_DELIVERY","MASK_PICKUP"]},{"type":"null"}],"title":"Neutral Order Type","description":"Neutral order"},"container":{"anyOf":[{"$ref":"#/components/schemas/ContainerExtraFields"},{"type":"null"}]},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"User defined additional fields for this order."},"vehicle_category":{"anyOf":[{"$ref":"#/components/schemas/VehicleCategory"},{"type":"null"}],"title":"Vehicle category"},"palletforce":{"anyOf":[{"$ref":"#/components/schemas/PalletforceExtraFields"},{"type":"null"}],"title":"Palletforce specific fields"},"kuehne_nagel":{"anyOf":[{"$ref":"#/components/schemas/KuehneNagelExtraFields"},{"type":"null"}],"title":"Kuehn Nagel specific fields"},"palletline":{"anyOf":[{"$ref":"#/components/schemas/PalletlineExtraFields"},{"type":"null"}],"title":"Palletline specific fields"},"transporeon":{"anyOf":[{"$ref":"#/components/schemas/TransporeonOrderExtraFields"},{"type":"null"}],"title":"Transporeon specific fields"},"dachser":{"anyOf":[{"$ref":"#/components/schemas/DachserExtraFields"},{"type":"null"}],"title":"Dachser specific fields"},"contact_emails":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Contact Emails","description":"List of contact emails to notify about the order"},"import_export":{"anyOf":[{"$ref":"#/components/schemas/ImportExportExtraFields"},{"type":"null"}],"title":"Fields specific to import and export"},"is_consignment_info_validated":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Consignment Info Validated","description":"Flag indicating all consignment information is validated. Customers can only set this to true; only planners (or API/internal callers) can revert it."},"operation":{"$ref":"#/components/schemas/OperationEnum"},"order_identifier":{"type":"string","title":"Order Identifier","description":"Identifier of the order when created from an external source"},"import_configuration":{"anyOf":[{"$ref":"#/components/schemas/ImportConfiguration"},{"type":"null"}],"description":"Additional import configuration","default":{"code":"API"}},"consignments":{"items":{"$ref":"#/components/schemas/ConsignmentInput-Output"},"type":"array","title":"Consignments"},"customer":{"$ref":"#/components/schemas/Entity","title":"Customer"},"transport_network":{"anyOf":[{"$ref":"#/components/schemas/Entity"},{"type":"null"}],"title":"Transport network","description":"Transport network within Qargo (Depot)"},"pricing":{"anyOf":[{"$ref":"#/components/schemas/OrderPricingInput"},{"type":"null"}],"description":"Pricing fields related to order"},"input_source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Input Source","description":"Source of this order input"},"raw_input":{"anyOf":[{"$ref":"#/components/schemas/RawInput"},{"type":"null"}],"description":"Original input document, for debugging purposes"},"order_status":{"$ref":"#/components/schemas/OrderStatus","description":"Status of the order","default":"TO_PLAN"},"setup_stops":{"anyOf":[{"items":{"$ref":"#/components/schemas/StopInput-Output"},"type":"array"},{"type":"null"}],"title":"Setup Stops","description":"List of stops for a container export scenario"},"teardown_stops":{"anyOf":[{"items":{"$ref":"#/components/schemas/StopInput-Output"},"type":"array"},{"type":"null"}],"title":"Teardown Stops","description":"List of stops for a container import scenario"},"container_load_unload_stop":{"anyOf":[{"$ref":"#/components/schemas/StopInput-Output"},{"type":"null"}],"title":"Container load/unload stop","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field practically maps to the container yard. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"setup_stops"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (for pick-up) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"teardown_stops"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (for drop-off) are replacing this field, please use them instead."},"children":[]}]}]}],"deprecated":true}},"type":"object","required":["operation","order_identifier","consignments","customer"],"title":"OrderExport"}},"components/schemas/OrderImport":{"id":"components/schemas/OrderImport","kind":"json-schema","title":"OrderImport","data":{"properties":{"upload_id":{"type":"string","format":"uuid","title":"Upload Id","description":"Unique identifier for the order import"},"upload_status":{"$ref":"#/components/schemas/UploadStatus","description":"Status of the order import"},"upload_url":{"type":"string","title":"Upload Url","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL to check the status of the order import, e.g. /v1/orders/order/upload/{upload_id}"},"children":[]}]}]}]},"order_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Order Id","description":"Unique identifier for the order, only available when it's an update to an existing order"},"order_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Order Url","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL to check the status of the order, e.g. /v1/orders/order/{order_id}, only available when it's update to an existing order"},"children":[]}]}]}]}},"type":"object","required":["upload_id","upload_status","upload_url"],"title":"OrderImport"}},"components/schemas/OrderImportExportInput":{"id":"components/schemas/OrderImportExportInput","kind":"json-schema","title":"OrderImportExportInput","data":{"properties":{"incoterm":{"anyOf":[{"$ref":"#/components/schemas/Incoterm"},{"type":"null"}]},"mrns":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Mrns"},"ens_mrns":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Ens Mrns"},"exs_mrns":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Exs Mrns"},"ducrs":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Ducrs"}},"type":"object","title":"OrderImportExportInput"}},"components/schemas/OrderImportResponse":{"id":"components/schemas/OrderImportResponse","kind":"json-schema","title":"OrderImportResponse","data":{"properties":{"errors":{"anyOf":[{"items":{"$ref":"#/components/schemas/ErrorStatus"},"type":"array"},{"type":"null"}],"title":"Errors","description":"List of errors that occurred during the webhook processing. If empty/omitted, the webhook was processed successfully.","examples":[{"error_message":"The payload is invalid.","error_type":"USER_INPUT_ERROR"},{"error_message":"Not supported.","error_type":"NOT_SUPPORTED"},{"error_message":"Unknown error.","error_type":"INTERNAL_ERROR"}]}},"type":"object","title":"OrderImportResponse","description":"Response schema for the order import webhook.\nThis schema is used to return errors or success messages."}},"components/schemas/OrderImportUpdate":{"id":"components/schemas/OrderImportUpdate","kind":"json-schema","title":"OrderImportUpdate","data":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id"},"type":{"type":"string","const":"OrderImport","title":"Type"},"status":{"$ref":"#/components/schemas/VisibilityOrderImportStatus"},"input_data":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Input Data","description":"Parsed input data for the order import instance."}},"type":"object","required":["type","status"],"title":"OrderImportUpdate"}},"components/schemas/OrderInput":{"id":"components/schemas/OrderInput","kind":"json-schema","title":"OrderInput","data":{"properties":{"transport_service":{"anyOf":[{"$ref":"#/components/schemas/Entity"},{"type":"null"}],"title":"Transport service","description":"Transport service within Qargo"},"customer_reference_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Order reference number from customer"},"service_level":{"anyOf":[{"$ref":"#/components/schemas/ServiceLevel"},{"type":"null"}]},"planning_instructions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Planning Instructions","description":"Additional freeform instructions for the planner."},"department":{"anyOf":[{"$ref":"#/components/schemas/Department"},{"type":"null"}],"description":"Department linked to order"},"neutral_order_type":{"anyOf":[{"type":"string","enum":["NO_NEUTRAL_ORDER","MASK_DELIVERY","MASK_PICKUP"]},{"type":"null"}],"title":"Neutral Order Type","description":"Neutral order"},"container":{"anyOf":[{"$ref":"#/components/schemas/ContainerExtraFields"},{"type":"null"}]},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"User defined additional fields for this order."},"vehicle_category":{"anyOf":[{"$ref":"#/components/schemas/VehicleCategory"},{"type":"null"}],"title":"Vehicle category"},"palletforce":{"anyOf":[{"$ref":"#/components/schemas/PalletforceExtraFields"},{"type":"null"}],"title":"Palletforce specific fields"},"kuehne_nagel":{"anyOf":[{"$ref":"#/components/schemas/KuehneNagelExtraFields"},{"type":"null"}],"title":"Kuehn Nagel specific fields"},"palletline":{"anyOf":[{"$ref":"#/components/schemas/PalletlineExtraFields"},{"type":"null"}],"title":"Palletline specific fields"},"transporeon":{"anyOf":[{"$ref":"#/components/schemas/TransporeonOrderExtraFields"},{"type":"null"}],"title":"Transporeon specific fields"},"dachser":{"anyOf":[{"$ref":"#/components/schemas/DachserExtraFields"},{"type":"null"}],"title":"Dachser specific fields"},"contact_emails":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Contact Emails","description":"List of contact emails to notify about the order"},"import_export":{"anyOf":[{"$ref":"#/components/schemas/ImportExportExtraFields"},{"type":"null"}],"title":"Fields specific to import and export"},"is_consignment_info_validated":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Consignment Info Validated","description":"Flag indicating all consignment information is validated. Customers can only set this to true; only planners (or API/internal callers) can revert it."},"operation":{"$ref":"#/components/schemas/OperationEnum"},"order_identifier":{"type":"string","title":"Order Identifier","description":"Identifier of the order when created from an external source"},"import_configuration":{"anyOf":[{"$ref":"#/components/schemas/ImportConfiguration"},{"type":"null"}],"description":"Additional import configuration","default":{"code":"API"}},"consignments":{"items":{"$ref":"#/components/schemas/ConsignmentInput-Input"},"type":"array","title":"Consignments"},"customer":{"$ref":"#/components/schemas/Entity","title":"Customer"},"transport_network":{"anyOf":[{"$ref":"#/components/schemas/Entity"},{"type":"null"}],"title":"Transport network","description":"Transport network within Qargo (Depot)"},"pricing":{"anyOf":[{"$ref":"#/components/schemas/OrderPricingInput"},{"type":"null"}],"description":"Pricing fields related to order"},"input_source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Input Source","description":"Source of this order input"},"raw_input":{"anyOf":[{"$ref":"#/components/schemas/RawInput"},{"type":"null"}],"description":"Original input document, for debugging purposes"},"order_status":{"$ref":"#/components/schemas/OrderStatus","description":"Status of the order","default":"TO_PLAN"},"setup_stops":{"anyOf":[{"items":{"$ref":"#/components/schemas/StopInput-Input"},"type":"array"},{"type":"null"}],"title":"Setup Stops","description":"List of stops for a container export scenario"},"teardown_stops":{"anyOf":[{"items":{"$ref":"#/components/schemas/StopInput-Input"},"type":"array"},{"type":"null"}],"title":"Teardown Stops","description":"List of stops for a container import scenario"},"container_load_unload_stop":{"anyOf":[{"$ref":"#/components/schemas/StopInput-Input"},{"type":"null"}],"title":"Container load/unload stop","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field practically maps to the container yard. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"setup_stops"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (for pick-up) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"teardown_stops"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (for drop-off) are replacing this field, please use them instead."},"children":[]}]}]}],"deprecated":true}},"type":"object","required":["operation","order_identifier","consignments","customer"],"title":"OrderInput"}},"components/schemas/OrderMatch":{"id":"components/schemas/OrderMatch","kind":"json-schema","title":"OrderMatch","data":{"properties":{"customer_reference_number":{"anyOf":[{"$ref":"#/components/schemas/FieldMatchInput"},{"type":"null"}]},"name":{"anyOf":[{"$ref":"#/components/schemas/FieldMatchInput"},{"type":"null"}]},"id":{"anyOf":[{"$ref":"#/components/schemas/FieldMatchInput"},{"type":"null"}]}},"type":"object","title":"OrderMatch"}},"components/schemas/OrderMetrics":{"id":"components/schemas/OrderMetrics","kind":"json-schema","title":"OrderMetrics","data":{"properties":{"distance_empty_km":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Distance Empty Km","description":"Distance in kilometers for empty vehicle"},"distance_loaded_km":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Distance Loaded Km","description":"Distance in kilometers for loaded vehicle"},"distance_total_km":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Distance Total Km","description":"Total distance in kilometers"}},"type":"object","title":"OrderMetrics"}},"components/schemas/OrderOutput-Input":{"id":"components/schemas/OrderOutput-Input","kind":"json-schema","title":"OrderOutput","data":{"properties":{"transport_service":{"anyOf":[{"$ref":"#/components/schemas/Entity"},{"type":"null"}],"title":"Transport service","description":"Transport service within Qargo"},"customer_reference_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Order reference number from customer"},"service_level":{"anyOf":[{"$ref":"#/components/schemas/ServiceLevel"},{"type":"null"}]},"planning_instructions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Planning Instructions","description":"Additional freeform instructions for the planner."},"department":{"anyOf":[{"$ref":"#/components/schemas/Department"},{"type":"null"}],"description":"Department linked to order"},"neutral_order_type":{"anyOf":[{"type":"string","enum":["NO_NEUTRAL_ORDER","MASK_DELIVERY","MASK_PICKUP"]},{"type":"null"}],"title":"Neutral Order Type","description":"Neutral order"},"container":{"anyOf":[{"$ref":"#/components/schemas/ContainerExtraFields"},{"type":"null"}]},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"User defined additional fields for this order."},"vehicle_category":{"anyOf":[{"$ref":"#/components/schemas/VehicleCategory"},{"type":"null"}],"title":"Vehicle category"},"palletforce":{"anyOf":[{"$ref":"#/components/schemas/PalletforceExtraFields"},{"type":"null"}],"title":"Palletforce specific fields"},"kuehne_nagel":{"anyOf":[{"$ref":"#/components/schemas/KuehneNagelExtraFields"},{"type":"null"}],"title":"Kuehn Nagel specific fields"},"palletline":{"anyOf":[{"$ref":"#/components/schemas/PalletlineExtraFields"},{"type":"null"}],"title":"Palletline specific fields"},"transporeon":{"anyOf":[{"$ref":"#/components/schemas/TransporeonOrderExtraFields"},{"type":"null"}],"title":"Transporeon specific fields"},"dachser":{"anyOf":[{"$ref":"#/components/schemas/DachserExtraFields"},{"type":"null"}],"title":"Dachser specific fields"},"contact_emails":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Contact Emails","description":"List of contact emails to notify about the order"},"import_export":{"anyOf":[{"$ref":"#/components/schemas/ImportExportExtraFields"},{"type":"null"}],"title":"Fields specific to import and export"},"is_consignment_info_validated":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Consignment Info Validated","description":"Flag indicating all consignment information is validated. Customers can only set this to true; only planners (or API/internal callers) can revert it."},"stops":{"anyOf":[{"items":{"$ref":"#/components/schemas/StopOutput-Input"},"type":"array"},{"type":"null"}],"title":"Stops","description":"List of stops in the order, ordered by their sequence"},"order_identifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Order Identifier","description":"Identifier of the order when created from an external source"},"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier for order"},"consignments":{"items":{"$ref":"#/components/schemas/ConsignmentOutput-Input"},"type":"array","title":"Consignments"},"pricing":{"anyOf":[{"$ref":"#/components/schemas/OrderPricingOutput"},{"type":"null"}],"description":"Pricing fields related to order"},"customer":{"$ref":"#/components/schemas/CompanyOutput-Input","title":"Customer"},"created_by_user":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By User","description":"User who created the order"},"created_timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created Timestamp","description":"Timestamp of creation"},"start_stop":{"anyOf":[{"$ref":"#/components/schemas/StopOutput-Input"},{"type":"null"}],"description":"First stop on this order"},"end_stop":{"anyOf":[{"$ref":"#/components/schemas/StopOutput-Input"},{"type":"null"}],"description":"Last stop on this order"},"quote_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quote Name","description":"Name of the quote"},"container_load_unload_stop":{"anyOf":[{"$ref":"#/components/schemas/StopOutput-Input"},{"type":"null"}],"title":"Container load/unload stop","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field practically maps to the container yard. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"setup_stops"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (for pick-up) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"teardown_stops"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (for drop-off) are replacing this field, please use them instead."},"children":[]}]}]}],"deprecated":true}},"type":"object","required":["id","consignments","customer"],"title":"OrderOutput"}},"components/schemas/OrderOutput-Output":{"id":"components/schemas/OrderOutput-Output","kind":"json-schema","title":"OrderOutput","data":{"properties":{"transport_service":{"anyOf":[{"$ref":"#/components/schemas/Entity"},{"type":"null"}],"title":"Transport service","description":"Transport service within Qargo"},"customer_reference_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Order reference number from customer"},"service_level":{"anyOf":[{"$ref":"#/components/schemas/ServiceLevel"},{"type":"null"}]},"planning_instructions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Planning Instructions","description":"Additional freeform instructions for the planner."},"department":{"anyOf":[{"$ref":"#/components/schemas/Department"},{"type":"null"}],"description":"Department linked to order"},"neutral_order_type":{"anyOf":[{"type":"string","enum":["NO_NEUTRAL_ORDER","MASK_DELIVERY","MASK_PICKUP"]},{"type":"null"}],"title":"Neutral Order Type","description":"Neutral order"},"container":{"anyOf":[{"$ref":"#/components/schemas/ContainerExtraFields"},{"type":"null"}]},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"User defined additional fields for this order."},"vehicle_category":{"anyOf":[{"$ref":"#/components/schemas/VehicleCategory"},{"type":"null"}],"title":"Vehicle category"},"palletforce":{"anyOf":[{"$ref":"#/components/schemas/PalletforceExtraFields"},{"type":"null"}],"title":"Palletforce specific fields"},"kuehne_nagel":{"anyOf":[{"$ref":"#/components/schemas/KuehneNagelExtraFields"},{"type":"null"}],"title":"Kuehn Nagel specific fields"},"palletline":{"anyOf":[{"$ref":"#/components/schemas/PalletlineExtraFields"},{"type":"null"}],"title":"Palletline specific fields"},"transporeon":{"anyOf":[{"$ref":"#/components/schemas/TransporeonOrderExtraFields"},{"type":"null"}],"title":"Transporeon specific fields"},"dachser":{"anyOf":[{"$ref":"#/components/schemas/DachserExtraFields"},{"type":"null"}],"title":"Dachser specific fields"},"contact_emails":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Contact Emails","description":"List of contact emails to notify about the order"},"import_export":{"anyOf":[{"$ref":"#/components/schemas/ImportExportExtraFields"},{"type":"null"}],"title":"Fields specific to import and export"},"is_consignment_info_validated":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Consignment Info Validated","description":"Flag indicating all consignment information is validated. Customers can only set this to true; only planners (or API/internal callers) can revert it."},"stops":{"anyOf":[{"items":{"$ref":"#/components/schemas/StopOutput-Output"},"type":"array"},{"type":"null"}],"title":"Stops","description":"List of stops in the order, ordered by their sequence"},"order_identifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Order Identifier","description":"Identifier of the order when created from an external source"},"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier for order"},"consignments":{"items":{"$ref":"#/components/schemas/ConsignmentOutput-Output"},"type":"array","title":"Consignments"},"pricing":{"anyOf":[{"$ref":"#/components/schemas/OrderPricingOutput"},{"type":"null"}],"description":"Pricing fields related to order"},"customer":{"$ref":"#/components/schemas/CompanyOutput-Output","title":"Customer"},"created_by_user":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By User","description":"User who created the order"},"created_timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created Timestamp","description":"Timestamp of creation"},"start_stop":{"anyOf":[{"$ref":"#/components/schemas/StopOutput-Output"},{"type":"null"}],"description":"First stop on this order"},"end_stop":{"anyOf":[{"$ref":"#/components/schemas/StopOutput-Output"},{"type":"null"}],"description":"Last stop on this order"},"quote_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quote Name","description":"Name of the quote"},"container_load_unload_stop":{"anyOf":[{"$ref":"#/components/schemas/StopOutput-Output"},{"type":"null"}],"title":"Container load/unload stop","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field practically maps to the container yard. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"setup_stops"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (for pick-up) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"teardown_stops"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (for drop-off) are replacing this field, please use them instead."},"children":[]}]}]}],"deprecated":true}},"type":"object","required":["id","consignments","customer"],"title":"OrderOutput"}},"components/schemas/OrderPricingInput":{"id":"components/schemas/OrderPricingInput","kind":"json-schema","title":"OrderPricingInput","data":{"properties":{"requested_price":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}],"title":"Requested Price","description":"Requested price"}},"type":"object","title":"OrderPricingInput"}},"components/schemas/OrderPricingOutput":{"id":"components/schemas/OrderPricingOutput","kind":"json-schema","title":"OrderPricingOutput","data":{"properties":{"total_excl_tax":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Total Excl Tax","description":"Total price excluding tax"},"total_incl_tax":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Total Incl Tax","description":"Total price including tax"},"total_tax":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Total Tax","description":"Total tax"},"requested_price":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}],"title":"Requested Price","description":"Requested price"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","description":"Currency code"},"by_currency":{"additionalProperties":{"$ref":"#/components/schemas/OrderPricingTotalsOutput"},"type":"object","title":"By Currency","description":"Pricing totals per currency, keyed by currency code. Each entry covers only the charges in that currency and does not repeat the currency code. Use these totals when the order has charges in more than one currency.","examples":[{"EUR":{"total_excl_tax":"100.00"}}]}},"type":"object","title":"OrderPricingOutput"}},"components/schemas/OrderPricingTotalsOutput":{"id":"components/schemas/OrderPricingTotalsOutput","kind":"json-schema","title":"OrderPricingTotalsOutput","data":{"properties":{"total_excl_tax":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Total Excl Tax","description":"Total price excluding tax"},"total_incl_tax":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Total Incl Tax","description":"Total price including tax"},"total_tax":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Total Tax","description":"Total tax"}},"type":"object","title":"OrderPricingTotalsOutput"}},"components/schemas/OrderReference":{"id":"components/schemas/OrderReference","kind":"json-schema","title":"OrderReference","data":{"properties":{"row_id":{"type":"string","format":"uuid","title":"Row Id","description":"Identifier of the reference"}},"type":"object","required":["row_id"],"title":"OrderReference"}},"components/schemas/OrderStatus":{"id":"components/schemas/OrderStatus","kind":"json-schema","title":"OrderStatus","data":{"type":"string","enum":["QUOTE","TO_PLAN"],"title":"OrderStatus"}},"components/schemas/OrderStatusStopOutput":{"id":"components/schemas/OrderStatusStopOutput","kind":"json-schema","title":"OrderStatusStopOutput","data":{"properties":{"activity_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Activity Label","description":"Activity to execute at this location, ie. pickup/collect, couple/uncouple trailer"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"Additional freeform data for this stop"},"reference_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"stop reference number"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number"},"mobile_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mobile Number"},"time_window":{"anyOf":[{"$ref":"#/components/schemas/TimeWindow"},{"type":"null"}],"title":"time_window"},"planning_instructions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Planning Instructions","description":"Additional freeform instructions for the planner."},"extras":{"anyOf":[{"items":{"$ref":"#/components/schemas/StopExtra"},"type":"array"},{"type":"null"}],"title":"Extras","description":"Additional services/options for stop"},"custom_fields":{"type":"object","title":"Custom Fields","description":"Additional user defined fields to fill in"},"date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date","description":"Requested date of the stop, as shown in the planning UI. Empty for stops without a requested date (e.g. standalone stops).","examples":["2024-12-31"]},"depot":{"anyOf":[{"$ref":"#/components/schemas/StopDepotOutput"},{"type":"null"}],"description":"Depot information for the stop. Only relevant for location bookings (load building)."},"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier for stop"},"location":{"$ref":"#/components/schemas/LocationWithTerminalOutput-Output","description":"Location of the stop"},"mileage_km":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Mileage Km","description":"Mileage in kilometers"},"end_timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Timestamp","description":"End of stop. The value depends on the stop status: the estimated end time until the stop reaches status COMPLETED, after which it is the actual end time reported during execution. ISO 8601 format in UTC.","examples":["2024-12-31T08:15:00Z"]},"start_timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Timestamp","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start of stop. The value depends on the stop status: the estimated start time until the stop reaches status AT_STOP, after which it is the actual start time reported during execution. ISO 8601 format in UTC."},"children":[]}]}]}],"examples":["2024-12-31T08:00:00Z"]},"incidents":{"anyOf":[{"items":{"$ref":"#/components/schemas/Incident"},"type":"array"},{"type":"null"}],"title":"Incidents","description":"List of incidents"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the stop. One of: TEMPLATE, BLOCKED, TO_PLAN, PLANNED, DISPATCHED, ROUTE_TO_STOP, AT_STOP, COMPLETED, CANCELLED, IGNORED."},"children":[]}]}]}],"examples":["PLANNED"]},"consignment_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Consignment Id","description":"ID of the consignment associated with this stop"},"stop_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stop Type","description":"Role of the stop in its consignment. One of: PICKUP, DELIVERY. Empty for other stops, such as drop/collect empty or resource setup stops.","examples":["PICKUP"]}},"type":"object","required":["id","location"],"title":"OrderStatusStopOutput"}},"components/schemas/OrderUpdate":{"id":"components/schemas/OrderUpdate","kind":"json-schema","title":"OrderUpdate","data":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id"},"type":{"type":"string","const":"Order","title":"Type"},"update_type":{"$ref":"#/components/schemas/OrderUpdateType","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of update:"},"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":"STATUS: Status update, see status field"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COST_APPROVAL_REQUEST: Cost approval request"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CUSTOM: Custom event, see custom_event_code field"},"children":[]}]}]}]}],"default":"STATUS"},"custom_event_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Custom Event Code"},"status":{"anyOf":[{"$ref":"#/components/schemas/VisibilityOrderStatus"},{"type":"null"}]}},"type":"object","required":["type"],"title":"OrderUpdate","description":"Send update event on order status change."}},"components/schemas/OrderUpdateData":{"id":"components/schemas/OrderUpdateData","kind":"json-schema","title":"OrderUpdateData","data":{"properties":{"transport_service":{"anyOf":[{"$ref":"#/components/schemas/Entity"},{"type":"null"}]},"transport_network":{"anyOf":[{"$ref":"#/components/schemas/Entity"},{"type":"null"}]},"service_level":{"anyOf":[{"$ref":"#/components/schemas/ServiceLevel"},{"type":"null"}]},"customer":{"anyOf":[{"$ref":"#/components/schemas/CustomerField"},{"type":"null"}]},"customer_reference_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Reference Number"},"order_group":{"anyOf":[{"$ref":"#/components/schemas/Entity"},{"type":"null"}]},"planning_instructions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Planning Instructions"},"planning_group":{"anyOf":[{"$ref":"#/components/schemas/PlanningGroup"},{"type":"null"}]},"department":{"anyOf":[{"$ref":"#/components/schemas/Department"},{"type":"null"}]},"vehicle_category":{"anyOf":[{"$ref":"#/components/schemas/VehicleCategory"},{"type":"null"}]},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Custom Fields"},"neutral_order_type":{"anyOf":[{"type":"string","enum":["NO_NEUTRAL_ORDER","MASK_DELIVERY","MASK_PICKUP"]},{"type":"null"}],"title":"Neutral Order Type"},"pricing":{"anyOf":[{"$ref":"#/components/schemas/UpdateOrderPricingInput"},{"type":"null"}]},"container":{"anyOf":[{"$ref":"#/components/schemas/ContainerOrderInput"},{"type":"null"}]},"palletforce":{"anyOf":[{"$ref":"#/components/schemas/PalletforceExtraFields"},{"type":"null"}]},"palletline":{"anyOf":[{"$ref":"#/components/schemas/PalletlineExtraFields"},{"type":"null"}]},"dachser":{"anyOf":[{"$ref":"#/components/schemas/DachserExtraFields"},{"type":"null"}]},"kuehne_nagel":{"anyOf":[{"$ref":"#/components/schemas/KuehneNagelExtraFields"},{"type":"null"}]},"chep":{"anyOf":[{"$ref":"#/components/schemas/ChepOrderInput"},{"type":"null"}]},"project44":{"anyOf":[{"$ref":"#/components/schemas/Project44OrderInput"},{"type":"null"}]},"shippeo":{"anyOf":[{"$ref":"#/components/schemas/ShippeoOrderInput"},{"type":"null"}]},"manuport":{"anyOf":[{"$ref":"#/components/schemas/ManuportOrderInput"},{"type":"null"}]},"transporeon":{"anyOf":[{"$ref":"#/components/schemas/TransporeonOrderExtraFields"},{"type":"null"}]},"import_export":{"anyOf":[{"$ref":"#/components/schemas/OrderImportExportInput"},{"type":"null"}]},"origin_country_of_goods":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Origin Country Of Goods"},"destination_country_of_goods":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Destination Country Of Goods"},"contact_emails":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Contact Emails"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id"}},"type":"object","title":"OrderUpdateData"}},"components/schemas/OrderUpdatePayload":{"id":"components/schemas/OrderUpdatePayload","kind":"json-schema","title":"OrderUpdatePayload","data":{"properties":{"updates":{"items":{"$ref":"#/components/schemas/PartialOrderUpdate"},"type":"array","title":"Updates","description":"List of orders to update"}},"type":"object","title":"OrderUpdatePayload"}},"components/schemas/OrderUpdateType":{"id":"components/schemas/OrderUpdateType","kind":"json-schema","title":"OrderUpdateType","data":{"type":"string","enum":["STATUS","COST_APPROVAL_REQUEST","CUSTOM"],"title":"OrderUpdateType"}},"components/schemas/OrderWithStatus":{"id":"components/schemas/OrderWithStatus","kind":"json-schema","title":"OrderWithStatus","data":{"properties":{"transport_service":{"anyOf":[{"$ref":"#/components/schemas/Entity"},{"type":"null"}],"title":"Transport service","description":"Transport service within Qargo"},"customer_reference_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Order reference number from customer"},"service_level":{"anyOf":[{"$ref":"#/components/schemas/ServiceLevel"},{"type":"null"}]},"planning_instructions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Planning Instructions","description":"Additional freeform instructions for the planner."},"department":{"anyOf":[{"$ref":"#/components/schemas/Department"},{"type":"null"}],"description":"Department linked to order"},"neutral_order_type":{"anyOf":[{"type":"string","enum":["NO_NEUTRAL_ORDER","MASK_DELIVERY","MASK_PICKUP"]},{"type":"null"}],"title":"Neutral Order Type","description":"Neutral order"},"container":{"anyOf":[{"$ref":"#/components/schemas/ContainerExtraFields"},{"type":"null"}]},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"User defined additional fields for this order."},"vehicle_category":{"anyOf":[{"$ref":"#/components/schemas/VehicleCategory"},{"type":"null"}],"title":"Vehicle category"},"palletforce":{"anyOf":[{"$ref":"#/components/schemas/PalletforceExtraFields"},{"type":"null"}],"title":"Palletforce specific fields"},"kuehne_nagel":{"anyOf":[{"$ref":"#/components/schemas/KuehneNagelExtraFields"},{"type":"null"}],"title":"Kuehn Nagel specific fields"},"palletline":{"anyOf":[{"$ref":"#/components/schemas/PalletlineExtraFields"},{"type":"null"}],"title":"Palletline specific fields"},"transporeon":{"anyOf":[{"$ref":"#/components/schemas/TransporeonOrderExtraFields"},{"type":"null"}],"title":"Transporeon specific fields"},"dachser":{"anyOf":[{"$ref":"#/components/schemas/DachserExtraFields"},{"type":"null"}],"title":"Dachser specific fields"},"contact_emails":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Contact Emails","description":"List of contact emails to notify about the order"},"import_export":{"anyOf":[{"$ref":"#/components/schemas/ImportExportExtraFields"},{"type":"null"}],"title":"Fields specific to import and export"},"is_consignment_info_validated":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Consignment Info Validated","description":"Flag indicating all consignment information is validated. Customers can only set this to true; only planners (or API/internal callers) can revert it."},"stops":{"anyOf":[{"items":{"$ref":"#/components/schemas/OrderStatusStopOutput"},"type":"array"},{"type":"null"}],"title":"Stops","description":"List of stops in the order, ordered by their sequence"},"order_identifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Order Identifier","description":"Identifier of the order when created from an external source"},"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier for order"},"consignments":{"items":{"$ref":"#/components/schemas/OrderConsignmentOutput-Output"},"type":"array","title":"Consignments"},"pricing":{"anyOf":[{"$ref":"#/components/schemas/OrderPricingOutput"},{"type":"null"}],"description":"Pricing fields related to order"},"customer":{"$ref":"#/components/schemas/CompanyOutput-Output","title":"Customer"},"created_by_user":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By User","description":"User who created the order"},"created_timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created Timestamp","description":"Timestamp of creation"},"start_stop":{"anyOf":[{"$ref":"#/components/schemas/StopOutput-Output"},{"type":"null"}],"description":"First stop on this order"},"end_stop":{"anyOf":[{"$ref":"#/components/schemas/StopOutput-Output"},{"type":"null"}],"description":"Last stop on this order"},"quote_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quote Name","description":"Name of the quote"},"shipments":{"anyOf":[{"items":{"$ref":"#/components/schemas/Shipment"},"type":"array"},{"type":"null"}],"title":"Shipments","description":"Shipment information"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status","description":"Status of the order"},"metrics":{"anyOf":[{"$ref":"#/components/schemas/OrderMetrics"},{"type":"null"}],"description":"Metrics related to the order"},"container_load_unload_stop":{"anyOf":[{"$ref":"#/components/schemas/StopOutput-Output"},{"type":"null"}],"title":"Container load/unload stop","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field practically maps to the container yard. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"setup_stops"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (for pick-up) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"teardown_stops"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (for drop-off) are replacing this field, please use them instead."},"children":[]}]}]}],"deprecated":true}},"additionalProperties":true,"type":"object","required":["id","consignments","customer"],"title":"OrderWithStatus"}},"components/schemas/PackagedItem-Input":{"id":"components/schemas/PackagedItem-Input","kind":"json-schema","title":"PackagedItem","data":{"properties":{"adr":{"anyOf":[{"$ref":"#/components/schemas/ADR-Input"},{"type":"null"}]},"waste":{"anyOf":[{"$ref":"#/components/schemas/PackagedItemWaste-Input"},{"type":"null"}]},"barcodes":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Barcodes","description":"List of barcodes associated with the packaged item"},"custom_fields":{"type":"object","title":"Custom Fields","description":"Store values for user defined fields"},"import_export":{"anyOf":[{"$ref":"#/components/schemas/PackagedItemsImportExportExtraFields"},{"type":"null"}]},"packaging_type":{"anyOf":[{"$ref":"#/components/schemas/PackagingType"},{"type":"null"}],"description":"Packaging type, for example Pallet"},"quantity":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Quantity","description":"Quantity of packaged items"},"total_net_weight_kg":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Net Weight Kg","description":"Total net weight of packaged items in KG"},"total_volume_l":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Volume L","description":"Total volume of packaged items in liter"},"total_weight_kg":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Weight Kg","description":"Total weight of packaged items in KG"},"unit_height_m":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Height M"},"unit_length_m":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Length M"},"unit_width_m":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Width M"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Description of the packaged item"}},"type":"object","title":"PackagedItem","description":"Synonym: GoodItem"}},"components/schemas/PackagedItem-Output":{"id":"components/schemas/PackagedItem-Output","kind":"json-schema","title":"PackagedItem","data":{"properties":{"adr":{"anyOf":[{"$ref":"#/components/schemas/ADR-Output"},{"type":"null"}]},"waste":{"anyOf":[{"$ref":"#/components/schemas/PackagedItemWaste-Output"},{"type":"null"}]},"barcodes":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Barcodes","description":"List of barcodes associated with the packaged item"},"custom_fields":{"type":"object","title":"Custom Fields","description":"Store values for user defined fields"},"import_export":{"anyOf":[{"$ref":"#/components/schemas/PackagedItemsImportExportExtraFields"},{"type":"null"}]},"packaging_type":{"anyOf":[{"$ref":"#/components/schemas/PackagingType"},{"type":"null"}],"description":"Packaging type, for example Pallet"},"quantity":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Quantity","description":"Quantity of packaged items"},"total_net_weight_kg":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Net Weight Kg","description":"Total net weight of packaged items in KG"},"total_volume_l":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Volume L","description":"Total volume of packaged items in liter"},"total_weight_kg":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Weight Kg","description":"Total weight of packaged items in KG"},"unit_height_m":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Height M"},"unit_length_m":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Length M"},"unit_width_m":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Width M"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Description of the packaged item"}},"type":"object","title":"PackagedItem","description":"Synonym: GoodItem"}},"components/schemas/PackagedItemCommercialInvoiceExtraField":{"id":"components/schemas/PackagedItemCommercialInvoiceExtraField","kind":"json-schema","title":"PackagedItemCommercialInvoiceExtraField","data":{"properties":{"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value","description":"Value of the commercial invoice"}},"type":"object","title":"PackagedItemCommercialInvoiceExtraField"}},"components/schemas/PackagedItemInput":{"id":"components/schemas/PackagedItemInput","kind":"json-schema","title":"PackagedItemInput","data":{"properties":{"adr":{"anyOf":[{"$ref":"#/components/schemas/ADRInput"},{"type":"null"}]},"waste":{"anyOf":[{"$ref":"#/components/schemas/PackagedItemWasteInput"},{"type":"null"}]},"barcodes":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Barcodes","description":"List of barcodes associated with the packaged item."},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Custom Fields"},"quantity":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Quantity"},"total_volume_l":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Volume L"},"total_weight_kg":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Weight Kg"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"import_export":{"anyOf":[{"$ref":"#/components/schemas/ImportExportInput"},{"type":"null"}]}},"type":"object","title":"PackagedItemInput"}},"components/schemas/PackagedItemOutput-Input":{"id":"components/schemas/PackagedItemOutput-Input","kind":"json-schema","title":"PackagedItemOutput","data":{"properties":{"adr":{"anyOf":[{"$ref":"#/components/schemas/ADR-Input"},{"type":"null"}]},"waste":{"anyOf":[{"$ref":"#/components/schemas/PackagedItemWaste-Input"},{"type":"null"}]},"barcodes":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Barcodes","description":"List of barcodes associated with the packaged item"},"custom_fields":{"type":"object","title":"Custom Fields","description":"Store values for user defined fields"},"import_export":{"anyOf":[{"$ref":"#/components/schemas/PackagedItemsImportExportExtraFields"},{"type":"null"}]},"packaging_type":{"anyOf":[{"$ref":"#/components/schemas/PackagingType"},{"type":"null"}],"description":"Packaging type, for example Pallet"},"quantity":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Quantity","description":"Quantity of packaged items"},"total_net_weight_kg":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Net Weight Kg","description":"Total net weight of packaged items in KG"},"total_volume_l":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Volume L","description":"Total volume of packaged items in liter"},"total_weight_kg":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Weight Kg","description":"Total weight of packaged items in KG"},"unit_height_m":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Height M"},"unit_length_m":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Length M"},"unit_width_m":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Width M"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Description of the packaged item"},"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier for this packaged item"}},"type":"object","required":["id"],"title":"PackagedItemOutput"}},"components/schemas/PackagedItemOutput-Output":{"id":"components/schemas/PackagedItemOutput-Output","kind":"json-schema","title":"PackagedItemOutput","data":{"properties":{"adr":{"anyOf":[{"$ref":"#/components/schemas/ADR-Output"},{"type":"null"}]},"waste":{"anyOf":[{"$ref":"#/components/schemas/PackagedItemWaste-Output"},{"type":"null"}]},"barcodes":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Barcodes","description":"List of barcodes associated with the packaged item"},"custom_fields":{"type":"object","title":"Custom Fields","description":"Store values for user defined fields"},"import_export":{"anyOf":[{"$ref":"#/components/schemas/PackagedItemsImportExportExtraFields"},{"type":"null"}]},"packaging_type":{"anyOf":[{"$ref":"#/components/schemas/PackagingType"},{"type":"null"}],"description":"Packaging type, for example Pallet"},"quantity":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Quantity","description":"Quantity of packaged items"},"total_net_weight_kg":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Net Weight Kg","description":"Total net weight of packaged items in KG"},"total_volume_l":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Volume L","description":"Total volume of packaged items in liter"},"total_weight_kg":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Weight Kg","description":"Total weight of packaged items in KG"},"unit_height_m":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Height M"},"unit_length_m":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Length M"},"unit_width_m":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Width M"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Description of the packaged item"},"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier for this packaged item"}},"type":"object","required":["id"],"title":"PackagedItemOutput"}},"components/schemas/PackagedItemWaste-Input":{"id":"components/schemas/PackagedItemWaste-Input","kind":"json-schema","title":"PackagedItemWaste","data":{"properties":{"ewc":{"anyOf":[{"$ref":"#/components/schemas/EWC"},{"type":"null"}],"description":"The European Waste Catalogue entry classifying this waste."},"consistency":{"anyOf":[{"items":{"$ref":"#/components/schemas/WasteConsistence"},"type":"array"},{"type":"null"}],"title":"Consistency","description":"Physical state of the waste. More than one value can apply."},"persistent_organic_pollutants":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Persistent Organic Pollutants","description":"Whether the waste contains persistent organic pollutants (POPs)."},"processing_operation":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Processing Operation","description":"Recovery or disposal operation code (R/D code).","examples":["R1"]},"emitter_type":{"anyOf":[{"$ref":"#/components/schemas/WasteEmitterType"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Who is producing the waste: the producer itself, a collection round ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPENDIX1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), a producer on a collection round ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPENDIX1_PRODUCER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), a regrouping ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPENDIX2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or another holder."},"children":[]}]}]}]}},"type":"object","title":"PackagedItemWaste"}},"components/schemas/PackagedItemWaste-Output":{"id":"components/schemas/PackagedItemWaste-Output","kind":"json-schema","title":"PackagedItemWaste","data":{"properties":{"ewc":{"anyOf":[{"$ref":"#/components/schemas/EWC"},{"type":"null"}],"description":"The European Waste Catalogue entry classifying this waste."},"consistency":{"anyOf":[{"items":{"$ref":"#/components/schemas/WasteConsistence"},"type":"array"},{"type":"null"}],"title":"Consistency","description":"Physical state of the waste. More than one value can apply."},"persistent_organic_pollutants":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Persistent Organic Pollutants","description":"Whether the waste contains persistent organic pollutants (POPs)."},"processing_operation":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Processing Operation","description":"Recovery or disposal operation code (R/D code).","examples":["R1"]},"emitter_type":{"anyOf":[{"$ref":"#/components/schemas/WasteEmitterType"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Who is producing the waste: the producer itself, a collection round ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPENDIX1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), a producer on a collection round ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPENDIX1_PRODUCER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), a regrouping ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPENDIX2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or another holder."},"children":[]}]}]}]}},"type":"object","title":"PackagedItemWaste"}},"components/schemas/PackagedItemWasteInput":{"id":"components/schemas/PackagedItemWasteInput","kind":"json-schema","title":"PackagedItemWasteInput","data":{"properties":{"ewc":{"anyOf":[{"$ref":"#/components/schemas/EWCInput"},{"type":"null"}],"description":"The European Waste Catalogue entry classifying this waste."},"consistency":{"anyOf":[{"items":{"type":"string","enum":["SOLID","LIQUID","GASEOUS","DOUGHY"]},"type":"array"},{"type":"null"}],"title":"Consistency","description":"Physical state of the waste. More than one value can apply."},"persistent_organic_pollutants":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Persistent Organic Pollutants","description":"Whether the waste contains persistent organic pollutants (POPs)."},"processing_operation":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Processing Operation","description":"Recovery or disposal operation code (R/D code).","examples":["R1"]},"emitter_type":{"anyOf":[{"type":"string","enum":["PRODUCER","OTHER","APPENDIX1","APPENDIX1_PRODUCER","APPENDIX2"]},{"type":"null"}],"title":"Emitter Type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Who is producing the waste: the producer itself, a collection round ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPENDIX1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), a producer on a collection round ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPENDIX1_PRODUCER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), a regrouping ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPENDIX2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or another holder."},"children":[]}]}]}]}},"type":"object","title":"PackagedItemWasteInput"}},"components/schemas/PackagedItemsImportExportExtraFields":{"id":"components/schemas/PackagedItemsImportExportExtraFields","kind":"json-schema","title":"PackagedItemsImportExportExtraFields","data":{"properties":{"hs_code_import":{"anyOf":[{"$ref":"#/components/schemas/HSCode"},{"type":"null"}],"description":"Harmonized System Code for importing the good"},"hs_code_export":{"anyOf":[{"$ref":"#/components/schemas/HSCode"},{"type":"null"}],"description":"Harmonized System Code for exporting the good"},"shipping_marks":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Shipping Marks","description":"Shipping marks for the good"},"commercial_invoice":{"anyOf":[{"$ref":"#/components/schemas/PackagedItemCommercialInvoiceExtraField"},{"type":"null"}]},"sps_flag":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Sps Flag","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sanitary & phytosanitary flag"},"children":[]}]}]}]},"sps_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sps Reference","description":"CHED / IPAFFS reference"},"ggb_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ggb Reference","description":"GGB reference (NL only)"}},"type":"object","title":"PackagedItemsImportExportExtraFields"}},"components/schemas/PackagingSize":{"id":"components/schemas/PackagingSize","kind":"json-schema","title":"PackagingSize","data":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Human readable identifier"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Machine readable identifier"},"height_m":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Height M","description":"Height in meters"},"length_m":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Length M","description":"Length in meters"},"width_m":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Width M","description":"Width in meters"},"weight_kg":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Weight Kg","description":"Weight in kg"},"loading_meters":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Loading Meters","description":"Loading meters"},"pallet_spaces":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Pallet Spaces","description":"Pallet spaces"}},"type":"object","title":"PackagingSize"}},"components/schemas/PackagingType":{"id":"components/schemas/PackagingType","kind":"json-schema","title":"PackagingType","data":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Human readable identifier"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Machine readable identifier"},"export_alias":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Export Alias","description":"Alias defined in the Qargo config"},"packaging_size":{"anyOf":[{"$ref":"#/components/schemas/PackagingSize"},{"type":"null"}],"description":"Size of packaging, for example Europallet"},"custom_fields":{"type":"object","title":"Custom Fields","description":"Store values for user defined fields"}},"type":"object","title":"PackagingType"}},"components/schemas/PalletTrackConsignmentInput":{"id":"components/schemas/PalletTrackConsignmentInput","kind":"json-schema","title":"PalletTrackConsignmentInput","data":{"properties":{"tracking_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tracking Code"},"job_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Job Number"}},"type":"object","title":"PalletTrackConsignmentInput"}},"components/schemas/PalletXpressIeConsignmentInput":{"id":"components/schemas/PalletXpressIeConsignmentInput","kind":"json-schema","title":"PalletXpressIeConsignmentInput","data":{"properties":{"job_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Job Number"}},"type":"object","title":"PalletXpressIeConsignmentInput"}},"components/schemas/PalletforceConsignmentExtraFields":{"id":"components/schemas/PalletforceConsignmentExtraFields","kind":"json-schema","title":"PalletforceConsignmentExtraFields","data":{"properties":{"palletforce_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Palletforce Id","description":"Palletforce ID"}},"type":"object","title":"PalletforceConsignmentExtraFields"}},"components/schemas/PalletforceConsignmentInput":{"id":"components/schemas/PalletforceConsignmentInput","kind":"json-schema","title":"PalletforceConsignmentInput","data":{"properties":{"customer_account_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Account Number"},"palletforce_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Palletforce Id"}},"type":"object","title":"PalletforceConsignmentInput"}},"components/schemas/PalletforceExtraFields":{"id":"components/schemas/PalletforceExtraFields","kind":"json-schema","title":"PalletforceExtraFields","data":{"properties":{"ni_company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ni Company Name","description":"Northern Ireland company name"},"ni_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ni Description","description":"Northern Ireland shipping info"},"ni_gbeori":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ni Gbeori","description":"Northern Ireland GBEORI"},"ni_tss_job_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ni Tss Job Reference","description":"Northern Ireland TSS JON reference"},"ni_tss_registration":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ni Tss Registration","description":"Northern Ireland TSS registration"}},"type":"object","title":"PalletforceExtraFields"}},"components/schemas/PalletlineConsignmentExtraFields":{"id":"components/schemas/PalletlineConsignmentExtraFields","kind":"json-schema","title":"PalletlineConsignmentExtraFields","data":{"properties":{"palletline_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Palletline Id","description":"Palletline ID"}},"type":"object","title":"PalletlineConsignmentExtraFields"}},"components/schemas/PalletlineConsignmentInput":{"id":"components/schemas/PalletlineConsignmentInput","kind":"json-schema","title":"PalletlineConsignmentInput","data":{"properties":{"palletline_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Palletline Id"},"third_party_label_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Third Party Label Id"}},"type":"object","title":"PalletlineConsignmentInput"}},"components/schemas/PalletlineExtraFields":{"id":"components/schemas/PalletlineExtraFields","kind":"json-schema","title":"PalletlineExtraFields","data":{"properties":{"terms_of_carriage":{"anyOf":[{"type":"string","enum":["1300","5000","10000","cmr","other"]},{"type":"null"}],"title":"Terms Of Carriage"}},"type":"object","title":"PalletlineExtraFields"}},"components/schemas/PalletwaysConsignmentInput":{"id":"components/schemas/PalletwaysConsignmentInput","kind":"json-schema","title":"PalletwaysConsignmentInput","data":{"properties":{"tracking_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tracking Id"},"consignment_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Consignment Number"}},"type":"object","title":"PalletwaysConsignmentInput"}},"components/schemas/PartialBaseResourceInput":{"id":"components/schemas/PartialBaseResourceInput","kind":"json-schema","title":"PartialBaseResourceInput","data":{"properties":{"is_archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Archived","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reactivate a previously archived resource, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to archive it. Only takes effect when included in the request; omit it to leave the archive state unchanged."},"children":[]}]}]}]},"billing_entity":{"anyOf":[{"$ref":"#/components/schemas/BillingEntityReference"},{"type":"null"}],"description":"Billing entity associated with the resource, defaults to default billing entity if not provided"},"extras":{"anyOf":[{"items":{"$ref":"#/components/schemas/ResourceExtraInput"},"type":"array"},{"type":"null"}],"title":"Extras","description":"Stop extras this resource is compatible with. Replaces the existing list when provided. Send an empty list to clear all compatible extras."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the resource"},"external_id":{"type":"string","title":"External Id","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"External identifier of the resource. Omit to leave the current value unchanged; send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to clear it. Despite the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" default shown, omitting the field does not clear it."},"children":[]}]}]}],"default":""},"locale":{"anyOf":[{"type":"string","pattern":"^[a-z]{2}(-[A-Z]{2})?$"},{"type":"null"}],"title":"Locale","description":"Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.","examples":["en","nl","en-GB","fr-BE"]},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code of the resource"},"note":{"type":"string","title":"Note","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note about the resource. Omit to leave the current value unchanged; send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to clear it. Despite the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" default shown, omitting the field does not clear it."},"children":[]}]}]}],"default":""},"custom_fields":{"type":"object","title":"Custom Fields","description":"User defined additional fields for this resource"},"subcontractor":{"anyOf":[{"$ref":"#/components/schemas/CompanyReference"},{"type":"null"}],"description":"Company linked to the resource"},"integrations":{"anyOf":[{"additionalProperties":{"type":"object"},"type":"object"},{"type":"null"}],"title":"Integrations","description":"Related integrations for the resource. The key is the unique code of the integration in Qargo","examples":[{"addsecure1234":{"active":true,"object_id":"1234"}}]},"resource_group":{"anyOf":[{"$ref":"#/components/schemas/ResourceGroupReference"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource group to allocate the resource to. Set to null to remove the resource from its current group; omit the field to leave the allocation unchanged. A resource can belong to multiple groups (see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resource_groups"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the resource); this field manages only its primary allocation."},"children":[]}]}]}]}},"type":"object","title":"PartialBaseResourceInput"}},"components/schemas/PartialChassisResourceInput":{"id":"components/schemas/PartialChassisResourceInput","kind":"json-schema","title":"PartialChassisResourceInput","data":{"properties":{"is_archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Archived","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reactivate a previously archived resource, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to archive it. Only takes effect when included in the request; omit it to leave the archive state unchanged."},"children":[]}]}]}]},"billing_entity":{"anyOf":[{"$ref":"#/components/schemas/BillingEntityReference"},{"type":"null"}],"description":"Billing entity associated with the resource, defaults to default billing entity if not provided"},"extras":{"anyOf":[{"items":{"$ref":"#/components/schemas/ResourceExtraInput"},"type":"array"},{"type":"null"}],"title":"Extras","description":"Stop extras this resource is compatible with. Replaces the existing list when provided. Send an empty list to clear all compatible extras."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the resource"},"external_id":{"type":"string","title":"External Id","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"External identifier of the resource. Omit to leave the current value unchanged; send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to clear it. Despite the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" default shown, omitting the field does not clear it."},"children":[]}]}]}],"default":""},"locale":{"anyOf":[{"type":"string","pattern":"^[a-z]{2}(-[A-Z]{2})?$"},{"type":"null"}],"title":"Locale","description":"Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.","examples":["en","nl","en-GB","fr-BE"]},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code of the resource"},"note":{"type":"string","title":"Note","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note about the resource. Omit to leave the current value unchanged; send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to clear it. Despite the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" default shown, omitting the field does not clear it."},"children":[]}]}]}],"default":""},"custom_fields":{"type":"object","title":"Custom Fields","description":"User defined additional fields for this resource"},"subcontractor":{"anyOf":[{"$ref":"#/components/schemas/CompanyReference"},{"type":"null"}],"description":"Company linked to the resource"},"integrations":{"anyOf":[{"additionalProperties":{"type":"object"},"type":"object"},{"type":"null"}],"title":"Integrations","description":"Related integrations for the resource. The key is the unique code of the integration in Qargo","examples":[{"addsecure1234":{"active":true,"object_id":"1234"}}]},"chassis":{"anyOf":[{"$ref":"#/components/schemas/ChassisProperties-Input"},{"type":"null"}],"description":"Chassis specific properties"},"resource_group":{"anyOf":[{"$ref":"#/components/schemas/ResourceGroupReference"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource group to allocate the resource to. Set to null to remove the resource from its current group; omit the field to leave the allocation unchanged. A resource can belong to multiple groups (see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resource_groups"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the resource); this field manages only its primary allocation."},"children":[]}]}]}]}},"type":"object","title":"PartialChassisResourceInput"}},"components/schemas/PartialDriverResourceInput":{"id":"components/schemas/PartialDriverResourceInput","kind":"json-schema","title":"PartialDriverResourceInput","data":{"properties":{"is_archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Archived","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reactivate a previously archived resource, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to archive it. Only takes effect when included in the request; omit it to leave the archive state unchanged."},"children":[]}]}]}]},"billing_entity":{"anyOf":[{"$ref":"#/components/schemas/BillingEntityReference"},{"type":"null"}],"description":"Billing entity associated with the resource, defaults to default billing entity if not provided"},"extras":{"anyOf":[{"items":{"$ref":"#/components/schemas/ResourceExtraInput"},"type":"array"},{"type":"null"}],"title":"Extras","description":"Stop extras this resource is compatible with. Replaces the existing list when provided. Send an empty list to clear all compatible extras."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the resource"},"external_id":{"type":"string","title":"External Id","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"External identifier of the resource. Omit to leave the current value unchanged; send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to clear it. Despite the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" default shown, omitting the field does not clear it."},"children":[]}]}]}],"default":""},"locale":{"anyOf":[{"type":"string","pattern":"^[a-z]{2}(-[A-Z]{2})?$"},{"type":"null"}],"title":"Locale","description":"Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.","examples":["en","nl","en-GB","fr-BE"]},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code of the resource"},"note":{"type":"string","title":"Note","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note about the resource. Omit to leave the current value unchanged; send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to clear it. Despite the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" default shown, omitting the field does not clear it."},"children":[]}]}]}],"default":""},"custom_fields":{"type":"object","title":"Custom Fields","description":"User defined additional fields for this resource"},"subcontractor":{"anyOf":[{"$ref":"#/components/schemas/CompanyReference"},{"type":"null"}],"description":"Company linked to the resource"},"integrations":{"anyOf":[{"additionalProperties":{"type":"object"},"type":"object"},{"type":"null"}],"title":"Integrations","description":"Related integrations for the resource. The key is the unique code of the integration in Qargo","examples":[{"addsecure1234":{"active":true,"object_id":"1234"}}]},"driver":{"anyOf":[{"$ref":"#/components/schemas/DriverProperties"},{"type":"null"}],"description":"Driver specific properties"},"resource_group":{"anyOf":[{"$ref":"#/components/schemas/ResourceGroupReference"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource group to allocate the resource to. Set to null to remove the resource from its current group; omit the field to leave the allocation unchanged. A resource can belong to multiple groups (see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resource_groups"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the resource); this field manages only its primary allocation."},"children":[]}]}]}]}},"type":"object","title":"PartialDriverResourceInput"}},"components/schemas/PartialFullTrailerResourceInput":{"id":"components/schemas/PartialFullTrailerResourceInput","kind":"json-schema","title":"PartialFullTrailerResourceInput","data":{"properties":{"is_archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Archived","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reactivate a previously archived resource, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to archive it. Only takes effect when included in the request; omit it to leave the archive state unchanged."},"children":[]}]}]}]},"billing_entity":{"anyOf":[{"$ref":"#/components/schemas/BillingEntityReference"},{"type":"null"}],"description":"Billing entity associated with the resource, defaults to default billing entity if not provided"},"extras":{"anyOf":[{"items":{"$ref":"#/components/schemas/ResourceExtraInput"},"type":"array"},{"type":"null"}],"title":"Extras","description":"Stop extras this resource is compatible with. Replaces the existing list when provided. Send an empty list to clear all compatible extras."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the resource"},"external_id":{"type":"string","title":"External Id","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"External identifier of the resource. Omit to leave the current value unchanged; send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to clear it. Despite the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" default shown, omitting the field does not clear it."},"children":[]}]}]}],"default":""},"locale":{"anyOf":[{"type":"string","pattern":"^[a-z]{2}(-[A-Z]{2})?$"},{"type":"null"}],"title":"Locale","description":"Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.","examples":["en","nl","en-GB","fr-BE"]},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code of the resource"},"note":{"type":"string","title":"Note","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note about the resource. Omit to leave the current value unchanged; send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to clear it. Despite the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" default shown, omitting the field does not clear it."},"children":[]}]}]}],"default":""},"custom_fields":{"type":"object","title":"Custom Fields","description":"User defined additional fields for this resource"},"subcontractor":{"anyOf":[{"$ref":"#/components/schemas/CompanyReference"},{"type":"null"}],"description":"Company linked to the resource"},"integrations":{"anyOf":[{"additionalProperties":{"type":"object"},"type":"object"},{"type":"null"}],"title":"Integrations","description":"Related integrations for the resource. The key is the unique code of the integration in Qargo","examples":[{"addsecure1234":{"active":true,"object_id":"1234"}}]},"full_trailer":{"anyOf":[{"$ref":"#/components/schemas/TrailerProperties-Input"},{"type":"null"}],"description":"Trailer specific properties"},"resource_group":{"anyOf":[{"$ref":"#/components/schemas/ResourceGroupReference"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource group to allocate the resource to. Set to null to remove the resource from its current group; omit the field to leave the allocation unchanged. A resource can belong to multiple groups (see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resource_groups"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the resource); this field manages only its primary allocation."},"children":[]}]}]}]}},"type":"object","title":"PartialFullTrailerResourceInput"}},"components/schemas/PartialLocationDetailInput":{"id":"components/schemas/PartialLocationDetailInput","kind":"json-schema","title":"PartialLocationDetailInput","data":{"properties":{"latitude":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Latitude","description":"Latitude of the location.","examples":[51.0543]},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Longitude","description":"Longitude of the location.","examples":[3.7174]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Free-text description of the location."},"selectable_on_customer_portal":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Selectable On Customer Portal","description":"Whether the location can be selected on the customer portal."},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Technical code for integrations/mapping logic; should be treated as stable once set.","examples":["LOC123"]},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name","description":"Human-readable label for a location in operational views.","examples":["Main Office"]},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":"Identifier from an external (master data) system."},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address","description":"First address line of the location","examples":["Gaston Crommenlaan 4"]},"address_second_line":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address Second Line","description":"Second address line of the location","examples":[""]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City of the location","examples":["Ghent"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State of the location","examples":[""]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code (ISO 3166-1 alpha-2) of the location","examples":["BE"]},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Postal Code","description":"Postal code of the location","examples":["9050"]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the location","examples":["Qargo HQ"]},"opening_hours":{"anyOf":[{"$ref":"#/components/schemas/WeekScheduleInput"},{"type":"null"}],"description":"Weekly opening hours for all seven days. Replaces the full schedule when provided."}},"type":"object","title":"PartialLocationDetailInput"}},"components/schemas/PartialOrderConsignment":{"id":"components/schemas/PartialOrderConsignment","kind":"json-schema","title":"PartialOrderConsignment","data":{"properties":{"updates":{"anyOf":[{"items":{"$ref":"#/components/schemas/PartialOrderConsignmentUpdate"},"type":"array"},{"type":"null"}],"title":"Updates"}},"type":"object","title":"PartialOrderConsignment"}},"components/schemas/PartialOrderConsignmentMatchInput":{"id":"components/schemas/PartialOrderConsignmentMatchInput","kind":"json-schema","title":"PartialOrderConsignmentMatchInput","data":{"properties":{"consignment":{"anyOf":[{"$ref":"#/components/schemas/ConsignmentMatch"},{"type":"null"}]}},"type":"object","title":"PartialOrderConsignmentMatchInput"}},"components/schemas/PartialOrderConsignmentMatchTarget":{"id":"components/schemas/PartialOrderConsignmentMatchTarget","kind":"json-schema","title":"PartialOrderConsignmentMatchTarget","data":{"properties":{"matches_all":{"items":{"$ref":"#/components/schemas/PartialOrderConsignmentMatchInput"},"type":"array","title":"Matches All"}},"type":"object","title":"PartialOrderConsignmentMatchTarget"}},"components/schemas/PartialOrderConsignmentUpdate":{"id":"components/schemas/PartialOrderConsignmentUpdate","kind":"json-schema","title":"PartialOrderConsignmentUpdate","data":{"properties":{"match":{"anyOf":[{"$ref":"#/components/schemas/PartialOrderConsignmentMatchTarget"},{"type":"null"}]},"good":{"anyOf":[{"$ref":"#/components/schemas/PartialOrderGood"},{"type":"null"}]},"stop":{"anyOf":[{"$ref":"#/components/schemas/PartialOrderStop"},{"type":"null"}]},"question_answers":{"type":"object","title":"Question Answers","description":"Question answers to update on the consignment. Mapping is configured in Qargo"},"update":{"anyOf":[{"$ref":"#/components/schemas/ConsignmentEntityUpdate"},{"type":"null"}]}},"type":"object","title":"PartialOrderConsignmentUpdate"}},"components/schemas/PartialOrderGood":{"id":"components/schemas/PartialOrderGood","kind":"json-schema","title":"PartialOrderGood","data":{"properties":{"updates":{"anyOf":[{"items":{"$ref":"#/components/schemas/PartialOrderGoodUpdate"},"type":"array"},{"type":"null"}],"title":"Updates"}},"type":"object","title":"PartialOrderGood"}},"components/schemas/PartialOrderGoodMatchInput":{"id":"components/schemas/PartialOrderGoodMatchInput","kind":"json-schema","title":"PartialOrderGoodMatchInput","data":{"properties":{"good":{"anyOf":[{"$ref":"#/components/schemas/GoodMatch"},{"type":"null"}]}},"type":"object","title":"PartialOrderGoodMatchInput"}},"components/schemas/PartialOrderGoodMatchTarget":{"id":"components/schemas/PartialOrderGoodMatchTarget","kind":"json-schema","title":"PartialOrderGoodMatchTarget","data":{"properties":{"matches_all":{"items":{"$ref":"#/components/schemas/PartialOrderGoodMatchInput"},"type":"array","title":"Matches All"}},"type":"object","title":"PartialOrderGoodMatchTarget"}},"components/schemas/PartialOrderGoodTrace":{"id":"components/schemas/PartialOrderGoodTrace","kind":"json-schema","title":"PartialOrderGoodTrace","data":{"properties":{"updates":{"anyOf":[{"items":{"$ref":"#/components/schemas/PartialOrderGoodTraceUpdate"},"type":"array"},{"type":"null"}],"title":"Updates"}},"type":"object","title":"PartialOrderGoodTrace"}},"components/schemas/PartialOrderGoodTraceMatchInput":{"id":"components/schemas/PartialOrderGoodTraceMatchInput","kind":"json-schema","title":"PartialOrderGoodTraceMatchInput","data":{"properties":{"handling_unit":{"anyOf":[{"$ref":"#/components/schemas/HandlingUnitMatch"},{"type":"null"}]}},"type":"object","title":"PartialOrderGoodTraceMatchInput"}},"components/schemas/PartialOrderGoodTraceMatchTarget":{"id":"components/schemas/PartialOrderGoodTraceMatchTarget","kind":"json-schema","title":"PartialOrderGoodTraceMatchTarget","data":{"properties":{"matches_all":{"items":{"$ref":"#/components/schemas/PartialOrderGoodTraceMatchInput"},"type":"array","title":"Matches All"}},"type":"object","title":"PartialOrderGoodTraceMatchTarget"}},"components/schemas/PartialOrderGoodTraceUpdate":{"id":"components/schemas/PartialOrderGoodTraceUpdate","kind":"json-schema","title":"PartialOrderGoodTraceUpdate","data":{"properties":{"match":{"anyOf":[{"$ref":"#/components/schemas/PartialOrderGoodTraceMatchTarget"},{"type":"null"}]},"question_answers":{"type":"object","title":"Question Answers","description":"Question answers to update on the handling unit. Mapping is configured in Qargo"},"update":{"anyOf":[{"$ref":"#/components/schemas/HandlingUnitEntityUpdate"},{"type":"null"}]}},"type":"object","title":"PartialOrderGoodTraceUpdate"}},"components/schemas/PartialOrderGoodUpdate":{"id":"components/schemas/PartialOrderGoodUpdate","kind":"json-schema","title":"PartialOrderGoodUpdate","data":{"properties":{"match":{"anyOf":[{"$ref":"#/components/schemas/PartialOrderGoodMatchTarget"},{"type":"null"}]},"handling_unit":{"anyOf":[{"$ref":"#/components/schemas/PartialOrderGoodTrace"},{"type":"null"}]},"question_answers":{"type":"object","title":"Question Answers","description":"Question answers to update on the good. Mapping is configured in Qargo"},"update":{"anyOf":[{"$ref":"#/components/schemas/GoodEntityUpdate"},{"type":"null"}]}},"type":"object","title":"PartialOrderGoodUpdate"}},"components/schemas/PartialOrderMatchInput":{"id":"components/schemas/PartialOrderMatchInput","kind":"json-schema","title":"PartialOrderMatchInput","data":{"properties":{"order":{"anyOf":[{"$ref":"#/components/schemas/OrderMatch"},{"type":"null"}]},"company":{"anyOf":[{"$ref":"#/components/schemas/CompanyMatch"},{"type":"null"}]}},"type":"object","title":"PartialOrderMatchInput"}},"components/schemas/PartialOrderMatchTarget":{"id":"components/schemas/PartialOrderMatchTarget","kind":"json-schema","title":"PartialOrderMatchTarget","data":{"properties":{"matches_all":{"items":{"$ref":"#/components/schemas/PartialOrderMatchInput"},"type":"array","title":"Matches All"}},"type":"object","title":"PartialOrderMatchTarget"}},"components/schemas/PartialOrderStop":{"id":"components/schemas/PartialOrderStop","kind":"json-schema","title":"PartialOrderStop","data":{"properties":{"updates":{"anyOf":[{"items":{"$ref":"#/components/schemas/PartialOrderStopUpdate"},"type":"array"},{"type":"null"}],"title":"Updates"}},"type":"object","title":"PartialOrderStop"}},"components/schemas/PartialOrderStopMatchInput":{"id":"components/schemas/PartialOrderStopMatchInput","kind":"json-schema","title":"PartialOrderStopMatchInput","data":{"properties":{"stop":{"anyOf":[{"$ref":"#/components/schemas/StopMatch"},{"type":"null"}]}},"type":"object","title":"PartialOrderStopMatchInput"}},"components/schemas/PartialOrderStopMatchTarget":{"id":"components/schemas/PartialOrderStopMatchTarget","kind":"json-schema","title":"PartialOrderStopMatchTarget","data":{"properties":{"matches_all":{"items":{"$ref":"#/components/schemas/PartialOrderStopMatchInput"},"type":"array","title":"Matches All"}},"type":"object","title":"PartialOrderStopMatchTarget"}},"components/schemas/PartialOrderStopUpdate":{"id":"components/schemas/PartialOrderStopUpdate","kind":"json-schema","title":"PartialOrderStopUpdate","data":{"properties":{"match":{"anyOf":[{"$ref":"#/components/schemas/PartialOrderStopMatchTarget"},{"type":"null"}]},"question_answers":{"type":"object","title":"Question Answers","description":"Question answers to update on the stop. Mapping is configured in Qargo"},"update":{"anyOf":[{"$ref":"#/components/schemas/StopEntityUpdate"},{"type":"null"}]}},"type":"object","title":"PartialOrderStopUpdate"}},"components/schemas/PartialOrderUpdate":{"id":"components/schemas/PartialOrderUpdate","kind":"json-schema","title":"PartialOrderUpdate","data":{"properties":{"match":{"anyOf":[{"$ref":"#/components/schemas/PartialOrderMatchTarget"},{"type":"null"}],"description":"Matching criteria for the order to update"},"consignment":{"anyOf":[{"$ref":"#/components/schemas/PartialOrderConsignment"},{"type":"null"}]},"question_answers":{"type":"object","title":"Question Answers","description":"Question answers to update on the order. Mapping is configured in Qargo"},"update":{"anyOf":[{"$ref":"#/components/schemas/OrderEntityUpdate"},{"type":"null"}]},"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replaced by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"match > order > id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Please use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"match > order > id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead"},"children":[]}]}]}],"deprecated":true}},"type":"object","title":"PartialOrderUpdate"}},"components/schemas/PartialOrderUpdateResponse":{"id":"components/schemas/PartialOrderUpdateResponse","kind":"json-schema","title":"PartialOrderUpdateResponse","data":{"properties":{"errors":{"anyOf":[{"items":{"$ref":"#/components/schemas/ErrorStatus"},"type":"array"},{"type":"null"}],"title":"Errors","description":"List of errors that occurred during the webhook processing. If empty/omitted, the webhook was processed successfully.","examples":[{"error_message":"The payload is invalid.","error_type":"USER_INPUT_ERROR"},{"error_message":"Not supported.","error_type":"NOT_SUPPORTED"},{"error_message":"Unknown error.","error_type":"INTERNAL_ERROR"}]}},"type":"object","title":"PartialOrderUpdateResponse","description":"Response schema for the partial order update webhook.\nThis schema is used to return errors or success messages."}},"components/schemas/PartialTractorResourceInput":{"id":"components/schemas/PartialTractorResourceInput","kind":"json-schema","title":"PartialTractorResourceInput","data":{"properties":{"is_archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Archived","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reactivate a previously archived resource, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to archive it. Only takes effect when included in the request; omit it to leave the archive state unchanged."},"children":[]}]}]}]},"billing_entity":{"anyOf":[{"$ref":"#/components/schemas/BillingEntityReference"},{"type":"null"}],"description":"Billing entity associated with the resource, defaults to default billing entity if not provided"},"extras":{"anyOf":[{"items":{"$ref":"#/components/schemas/ResourceExtraInput"},"type":"array"},{"type":"null"}],"title":"Extras","description":"Stop extras this resource is compatible with. Replaces the existing list when provided. Send an empty list to clear all compatible extras."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the resource"},"external_id":{"type":"string","title":"External Id","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"External identifier of the resource. Omit to leave the current value unchanged; send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to clear it. Despite the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" default shown, omitting the field does not clear it."},"children":[]}]}]}],"default":""},"locale":{"anyOf":[{"type":"string","pattern":"^[a-z]{2}(-[A-Z]{2})?$"},{"type":"null"}],"title":"Locale","description":"Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.","examples":["en","nl","en-GB","fr-BE"]},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code of the resource"},"note":{"type":"string","title":"Note","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note about the resource. Omit to leave the current value unchanged; send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to clear it. Despite the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" default shown, omitting the field does not clear it."},"children":[]}]}]}],"default":""},"custom_fields":{"type":"object","title":"Custom Fields","description":"User defined additional fields for this resource"},"subcontractor":{"anyOf":[{"$ref":"#/components/schemas/CompanyReference"},{"type":"null"}],"description":"Company linked to the resource"},"integrations":{"anyOf":[{"additionalProperties":{"type":"object"},"type":"object"},{"type":"null"}],"title":"Integrations","description":"Related integrations for the resource. The key is the unique code of the integration in Qargo","examples":[{"addsecure1234":{"active":true,"object_id":"1234"}}]},"tractor":{"anyOf":[{"$ref":"#/components/schemas/TractorProperties-Input"},{"type":"null"}],"description":"Tractor specific properties"},"resource_group":{"anyOf":[{"$ref":"#/components/schemas/ResourceGroupReference"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource group to allocate the resource to. Set to null to remove the resource from its current group; omit the field to leave the allocation unchanged. A resource can belong to multiple groups (see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resource_groups"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the resource); this field manages only its primary allocation."},"children":[]}]}]}]}},"type":"object","title":"PartialTractorResourceInput"}},"components/schemas/PartialTrailerResourceInput":{"id":"components/schemas/PartialTrailerResourceInput","kind":"json-schema","title":"PartialTrailerResourceInput","data":{"properties":{"is_archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Archived","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reactivate a previously archived resource, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to archive it. Only takes effect when included in the request; omit it to leave the archive state unchanged."},"children":[]}]}]}]},"billing_entity":{"anyOf":[{"$ref":"#/components/schemas/BillingEntityReference"},{"type":"null"}],"description":"Billing entity associated with the resource, defaults to default billing entity if not provided"},"extras":{"anyOf":[{"items":{"$ref":"#/components/schemas/ResourceExtraInput"},"type":"array"},{"type":"null"}],"title":"Extras","description":"Stop extras this resource is compatible with. Replaces the existing list when provided. Send an empty list to clear all compatible extras."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the resource"},"external_id":{"type":"string","title":"External Id","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"External identifier of the resource. Omit to leave the current value unchanged; send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to clear it. Despite the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" default shown, omitting the field does not clear it."},"children":[]}]}]}],"default":""},"locale":{"anyOf":[{"type":"string","pattern":"^[a-z]{2}(-[A-Z]{2})?$"},{"type":"null"}],"title":"Locale","description":"Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.","examples":["en","nl","en-GB","fr-BE"]},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code of the resource"},"note":{"type":"string","title":"Note","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note about the resource. Omit to leave the current value unchanged; send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to clear it. Despite the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" default shown, omitting the field does not clear it."},"children":[]}]}]}],"default":""},"custom_fields":{"type":"object","title":"Custom Fields","description":"User defined additional fields for this resource"},"subcontractor":{"anyOf":[{"$ref":"#/components/schemas/CompanyReference"},{"type":"null"}],"description":"Company linked to the resource"},"integrations":{"anyOf":[{"additionalProperties":{"type":"object"},"type":"object"},{"type":"null"}],"title":"Integrations","description":"Related integrations for the resource. The key is the unique code of the integration in Qargo","examples":[{"addsecure1234":{"active":true,"object_id":"1234"}}]},"trailer":{"anyOf":[{"$ref":"#/components/schemas/TrailerProperties-Input"},{"type":"null"}],"description":"Trailer specific properties"},"resource_group":{"anyOf":[{"$ref":"#/components/schemas/ResourceGroupReference"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource group to allocate the resource to. Set to null to remove the resource from its current group; omit the field to leave the allocation unchanged. A resource can belong to multiple groups (see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resource_groups"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the resource); this field manages only its primary allocation."},"children":[]}]}]}]}},"type":"object","title":"PartialTrailerResourceInput"}},"components/schemas/PartialTruckResourceInput":{"id":"components/schemas/PartialTruckResourceInput","kind":"json-schema","title":"PartialTruckResourceInput","data":{"properties":{"is_archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Archived","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reactivate a previously archived resource, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to archive it. Only takes effect when included in the request; omit it to leave the archive state unchanged."},"children":[]}]}]}]},"billing_entity":{"anyOf":[{"$ref":"#/components/schemas/BillingEntityReference"},{"type":"null"}],"description":"Billing entity associated with the resource, defaults to default billing entity if not provided"},"extras":{"anyOf":[{"items":{"$ref":"#/components/schemas/ResourceExtraInput"},"type":"array"},{"type":"null"}],"title":"Extras","description":"Stop extras this resource is compatible with. Replaces the existing list when provided. Send an empty list to clear all compatible extras."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the resource"},"external_id":{"type":"string","title":"External Id","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"External identifier of the resource. Omit to leave the current value unchanged; send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to clear it. Despite the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" default shown, omitting the field does not clear it."},"children":[]}]}]}],"default":""},"locale":{"anyOf":[{"type":"string","pattern":"^[a-z]{2}(-[A-Z]{2})?$"},{"type":"null"}],"title":"Locale","description":"Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.","examples":["en","nl","en-GB","fr-BE"]},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code of the resource"},"note":{"type":"string","title":"Note","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note about the resource. Omit to leave the current value unchanged; send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to clear it. Despite the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" default shown, omitting the field does not clear it."},"children":[]}]}]}],"default":""},"custom_fields":{"type":"object","title":"Custom Fields","description":"User defined additional fields for this resource"},"subcontractor":{"anyOf":[{"$ref":"#/components/schemas/CompanyReference"},{"type":"null"}],"description":"Company linked to the resource"},"integrations":{"anyOf":[{"additionalProperties":{"type":"object"},"type":"object"},{"type":"null"}],"title":"Integrations","description":"Related integrations for the resource. The key is the unique code of the integration in Qargo","examples":[{"addsecure1234":{"active":true,"object_id":"1234"}}]},"truck":{"anyOf":[{"$ref":"#/components/schemas/TruckProperties-Input"},{"type":"null"}],"description":"Truck specific properties"},"resource_group":{"anyOf":[{"$ref":"#/components/schemas/ResourceGroupReference"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource group to allocate the resource to. Set to null to remove the resource from its current group; omit the field to leave the allocation unchanged. A resource can belong to multiple groups (see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resource_groups"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the resource); this field manages only its primary allocation."},"children":[]}]}]}]}},"type":"object","title":"PartialTruckResourceInput"}},"components/schemas/PartialVanResourceInput":{"id":"components/schemas/PartialVanResourceInput","kind":"json-schema","title":"PartialVanResourceInput","data":{"properties":{"is_archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Archived","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reactivate a previously archived resource, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to archive it. Only takes effect when included in the request; omit it to leave the archive state unchanged."},"children":[]}]}]}]},"billing_entity":{"anyOf":[{"$ref":"#/components/schemas/BillingEntityReference"},{"type":"null"}],"description":"Billing entity associated with the resource, defaults to default billing entity if not provided"},"extras":{"anyOf":[{"items":{"$ref":"#/components/schemas/ResourceExtraInput"},"type":"array"},{"type":"null"}],"title":"Extras","description":"Stop extras this resource is compatible with. Replaces the existing list when provided. Send an empty list to clear all compatible extras."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the resource"},"external_id":{"type":"string","title":"External Id","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"External identifier of the resource. Omit to leave the current value unchanged; send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to clear it. Despite the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" default shown, omitting the field does not clear it."},"children":[]}]}]}],"default":""},"locale":{"anyOf":[{"type":"string","pattern":"^[a-z]{2}(-[A-Z]{2})?$"},{"type":"null"}],"title":"Locale","description":"Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.","examples":["en","nl","en-GB","fr-BE"]},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code of the resource"},"note":{"type":"string","title":"Note","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note about the resource. Omit to leave the current value unchanged; send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to clear it. Despite the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" default shown, omitting the field does not clear it."},"children":[]}]}]}],"default":""},"custom_fields":{"type":"object","title":"Custom Fields","description":"User defined additional fields for this resource"},"subcontractor":{"anyOf":[{"$ref":"#/components/schemas/CompanyReference"},{"type":"null"}],"description":"Company linked to the resource"},"integrations":{"anyOf":[{"additionalProperties":{"type":"object"},"type":"object"},{"type":"null"}],"title":"Integrations","description":"Related integrations for the resource. The key is the unique code of the integration in Qargo","examples":[{"addsecure1234":{"active":true,"object_id":"1234"}}]},"van":{"anyOf":[{"$ref":"#/components/schemas/VanProperties-Input"},{"type":"null"}],"description":"Van specific properties"},"resource_group":{"anyOf":[{"$ref":"#/components/schemas/ResourceGroupReference"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource group to allocate the resource to. Set to null to remove the resource from its current group; omit the field to leave the allocation unchanged. A resource can belong to multiple groups (see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resource_groups"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the resource); this field manages only its primary allocation."},"children":[]}]}]}]}},"type":"object","title":"PartialVanResourceInput"}},"components/schemas/PaymentStatus":{"id":"components/schemas/PaymentStatus","kind":"json-schema","title":"PaymentStatus","data":{"type":"string","enum":["UNPAID","PAID"],"title":"PaymentStatus"}},"components/schemas/PaymentStatusUpdate":{"id":"components/schemas/PaymentStatusUpdate","kind":"json-schema","title":"PaymentStatusUpdate","data":{"properties":{"status":{"$ref":"#/components/schemas/PaymentStatus"}},"type":"object","required":["status"],"title":"PaymentStatusUpdate"}},"components/schemas/PaymentTermCode":{"id":"components/schemas/PaymentTermCode","kind":"json-schema","title":"PaymentTermCode","data":{"type":"string","enum":["END_OF_MONTH_2","END_OF_MONTH_1","END_OF_MONTH_0_NET_90","END_OF_MONTH_0_NET_75","END_OF_MONTH_0_NET_70","END_OF_MONTH_0_NET_65","END_OF_MONTH_0_NET_60","END_OF_MONTH_0_NET_50","END_OF_MONTH_0_NET_45","END_OF_MONTH_0_NET_35","END_OF_MONTH_0_NET_31","END_OF_MONTH_0_NET_30","END_OF_MONTH_0_NET_25","END_OF_MONTH_0_NET_21","END_OF_MONTH_0_NET_20","END_OF_MONTH_0_NET_14","END_OF_MONTH_0_NET_7","END_OF_MONTH_0_NET_1","END_OF_MONTH_0","PREPAID","CUSTOM_DUE_DATE","UPON_RECEIPT","NET_1","NET_2","NET_3","NET_5","NET_7","NET_8","NET_10","NET_12","NET_14","NET_15","NET_20","NET_21","NET_28","NET_30","NET_35","NET_40","NET_42","NET_45","NET_48","NET_49","NET_50","NET_52","NET_55","NET_56","NET_60","NET_63","NET_70","NET_75","NET_77","NET_80","NET_84","NET_90","NET_91","NET_98","NET_120"],"title":"PaymentTermCode"}},"components/schemas/PlanningGroup":{"id":"components/schemas/PlanningGroup","kind":"json-schema","title":"PlanningGroup","data":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the planning group"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code of the planning group"}},"type":"object","title":"PlanningGroup"}},"components/schemas/Plugging":{"id":"components/schemas/Plugging","kind":"json-schema","title":"Plugging","data":{"properties":{"on_place_of_loading":{"type":"boolean","title":"On Place Of Loading","description":"Whether the unit is plugged in for power at the place of loading.","default":false},"on_vessel":{"type":"boolean","title":"On Vessel","description":"Whether the unit is plugged in for power while on the vessel.","default":false},"on_place_of_unloading":{"type":"boolean","title":"On Place Of Unloading","description":"Whether the unit is plugged in for power at the place of unloading.","default":false}},"type":"object","title":"Plugging"}},"components/schemas/Position":{"id":"components/schemas/Position","kind":"json-schema","title":"Position","data":{"properties":{"longitude":{"type":"number","title":"Longitude","description":"The longitude of the position"},"latitude":{"type":"number","title":"Latitude","description":"The latitude of the position"}},"type":"object","required":["longitude","latitude"],"title":"Position"}},"components/schemas/PositionUpdate":{"id":"components/schemas/PositionUpdate","kind":"json-schema","title":"PositionUpdate","data":{"properties":{"type":{"type":"string","const":"Position","title":"Type"},"position":{"$ref":"#/components/schemas/Position"}},"type":"object","required":["type","position"],"title":"PositionUpdate","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send update event on resource (driver, vehicle, subcontractor) position update."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Spec only, under development 🚧\","},"children":[]}]}]}]}},"components/schemas/PriceListItemReference":{"id":"components/schemas/PriceListItemReference","kind":"json-schema","title":"PriceListItemReference","data":{"properties":{"code":{"type":"string","title":"Code","description":"Code of the reference"}},"type":"object","required":["code"],"title":"PriceListItemReference"}},"components/schemas/Product":{"id":"components/schemas/Product","kind":"json-schema","title":"Product","data":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Human readable identifier"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Machine readable identifier"},"product_type":{"anyOf":[{"$ref":"#/components/schemas/Entity"},{"type":"null"}],"description":"Product type"},"custom_fields":{"type":"object","title":"Custom Fields","description":"Store values for user defined fields"}},"type":"object","title":"Product"}},"components/schemas/Project44ConsignmentInput":{"id":"components/schemas/Project44ConsignmentInput","kind":"json-schema","title":"Project44ConsignmentInput","data":{"properties":{"bill_of_lading":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bill Of Lading"},"order_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Order Id"}},"type":"object","title":"Project44ConsignmentInput"}},"components/schemas/Project44OrderInput":{"id":"components/schemas/Project44OrderInput","kind":"json-schema","title":"Project44OrderInput","data":{"properties":{"bill_of_lading":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bill Of Lading"},"order_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Order Id"}},"type":"object","title":"Project44OrderInput"}},"components/schemas/PurchaseCompanyFields-Input":{"id":"components/schemas/PurchaseCompanyFields-Input","kind":"json-schema","title":"PurchaseCompanyFields","data":{"properties":{"payment_term":{"anyOf":[{"$ref":"#/components/schemas/BasePaymentTerm"},{"type":"null"}],"description":"Payment term information of the company"},"billing_entities":{"anyOf":[{"items":{"$ref":"#/components/schemas/CompanyBillingEntity"},"type":"array"},{"type":"null"}],"title":"Billing Entities","description":"List of billing entities associated with the company"},"status":{"anyOf":[{"$ref":"#/components/schemas/SubcontractorStatus"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status indicates whether an order can be linked to this subcontractor. The available statuses are:"},"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":"code","inline":true,"attributes":{"content":"NOT_APPROVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The subcontractor is not yet approved."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPROVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The subcontractor is approved."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WARNING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The subcontractor is approved, but a warning is triggered."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BLOCKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The subcontractor is blocked; no new orders can be assigned."},"children":[]}]}]}]}],"default":"APPROVED","examples":["APPROVED"]}},"type":"object","title":"PurchaseCompanyFields"}},"components/schemas/PurchaseCompanyFields-Output":{"id":"components/schemas/PurchaseCompanyFields-Output","kind":"json-schema","title":"PurchaseCompanyFields","data":{"properties":{"payment_term":{"anyOf":[{"$ref":"#/components/schemas/BasePaymentTerm"},{"type":"null"}],"description":"Payment term information of the company"},"billing_entities":{"anyOf":[{"items":{"$ref":"#/components/schemas/CompanyBillingEntity"},"type":"array"},{"type":"null"}],"title":"Billing Entities","description":"List of billing entities associated with the company"},"status":{"anyOf":[{"$ref":"#/components/schemas/SubcontractorStatus"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status indicates whether an order can be linked to this subcontractor. The available statuses are:"},"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":"code","inline":true,"attributes":{"content":"NOT_APPROVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The subcontractor is not yet approved."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPROVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The subcontractor is approved."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WARNING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The subcontractor is approved, but a warning is triggered."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BLOCKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The subcontractor is blocked; no new orders can be assigned."},"children":[]}]}]}]}],"default":"APPROVED","examples":["APPROVED"]}},"type":"object","title":"PurchaseCompanyFields"}},"components/schemas/PurchaseCreditNote":{"id":"components/schemas/PurchaseCreditNote","kind":"json-schema","title":"PurchaseCreditNote","data":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id"},"name":{"type":"string","title":"Name","examples":["Credit-Note-0001"]},"external_name":{"type":"string","title":"External Name","description":"Reference from crediting party"},"date":{"type":"string","format":"date","title":"Date","description":"invoice date","examples":["2022-01-01"]},"booking_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Booking Date","description":"booking date needs to be enabled else this will default to the date field","examples":["2021-12-22"]},"currency":{"type":"string","title":"Currency","examples":["EUR"]},"exchange_rate":{"anyOf":[{"$ref":"#/components/schemas/ExchangeRate"},{"type":"null"}]},"total_excl_tax":{"type":"string","title":"Total Excl Tax","examples":["100"]},"total_incl_tax":{"type":"string","title":"Total Incl Tax","examples":["121"]},"total_tax":{"type":"string","title":"Total Tax","examples":["21"]},"custom_fields":{"type":"object","title":"Custom Fields","default":{}},"supplier":{"$ref":"#/components/schemas/CompanySummaryOutput"},"customer_reference_numbers":{"items":{"type":"string"},"type":"array","title":"Customer Reference Numbers","examples":[["12345"]]},"line_items":{"items":{"$ref":"#/components/schemas/LineItem"},"type":"array","title":"Line Items"},"billing_entity":{"$ref":"#/components/schemas/BillingEntity","description":"Billing entity linked to this credit note."}},"type":"object","required":["name","external_name","date","currency","total_excl_tax","total_incl_tax","total_tax","supplier","line_items","billing_entity"],"title":"PurchaseCreditNote"}},"components/schemas/PurchaseCreditNoteInput":{"id":"components/schemas/PurchaseCreditNoteInput","kind":"json-schema","title":"PurchaseCreditNoteInput","data":{"properties":{"custom_fields":{"type":"object","title":"Custom Fields","description":"User defined additional fields."}},"type":"object","title":"PurchaseCreditNoteInput"}},"components/schemas/PurchaseCreditNoteStatusUpdate":{"id":"components/schemas/PurchaseCreditNoteStatusUpdate","kind":"json-schema","title":"PurchaseCreditNoteStatusUpdate","data":{"properties":{"type":{"type":"string","const":"PurchaseCreditNote","title":"Type"},"id":{"type":"string","format":"uuid","title":"Id","description":"ID of the invoice or credit note"},"status":{"$ref":"#/components/schemas/CreditNoteStatus"}},"type":"object","required":["type","id","status"],"title":"PurchaseCreditNoteStatusUpdate"}},"components/schemas/PurchaseECreditNoteInput":{"id":"components/schemas/PurchaseECreditNoteInput","kind":"json-schema","title":"PurchaseECreditNoteInput","data":{"properties":{"name":{"type":"string","title":"Name","description":"Reference from invoicing party.","examples":["Invoice-0001"]},"date":{"type":"string","format":"date","title":"Date","description":"Invoice transaction date.","examples":["2022-01-01"]},"currency":{"type":"string","title":"Currency","description":"Currency code of the e-invoice.","examples":["EUR"]},"exchange_rate":{"anyOf":[{"$ref":"#/components/schemas/ExchangeRate"},{"type":"null"}],"description":"Exchange rate information if applicable."},"total_excl_tax":{"anyOf":[{"type":"number"},{"type":"string"}],"title":"Total Excl Tax","description":"Total amount excluding tax for the e-invoice.","examples":["100"]},"total_incl_tax":{"anyOf":[{"type":"number"},{"type":"string"}],"title":"Total Incl Tax","description":"Total amount including tax for the e-invoice.","examples":["121"]},"total_tax":{"anyOf":[{"type":"number"},{"type":"string"}],"title":"Total Tax","description":"Total tax amount for the e-invoice.","examples":["21"]},"custom_fields":{"type":"object","title":"Custom Fields","description":"Custom fields associated with this e-invoice."},"supplier":{"$ref":"#/components/schemas/EInvoiceCompanyInput","description":"Supplier company information."},"customer_reference_numbers":{"items":{"type":"string"},"type":"array","title":"Customer Reference Numbers","description":"Reference numbers used to match the invoice.","examples":[["12345"]]},"line_items":{"items":{"$ref":"#/components/schemas/EInvoiceLineItem"},"type":"array","title":"Line Items","description":"List of invoice lines associated with this e-invoice."},"attachments":{"anyOf":[{"items":{"$ref":"#/components/schemas/EInvoiceAttachment"},"type":"array"},{"type":"null"}],"title":"Attachments","description":"List of document attachments associated with this e-invoice."},"invoice_type":{"type":"string","const":"PURCHASE_CREDIT_NOTE","title":"Invoice Type","description":"Indicates that this is a purchase credit note."}},"type":"object","required":["name","date","currency","total_excl_tax","total_incl_tax","total_tax","supplier","line_items","invoice_type"],"title":"PurchaseECreditNoteInput"}},"components/schemas/PurchaseEInvoiceInput":{"id":"components/schemas/PurchaseEInvoiceInput","kind":"json-schema","title":"PurchaseEInvoiceInput","data":{"properties":{"name":{"type":"string","title":"Name","description":"Reference from invoicing party.","examples":["Invoice-0001"]},"date":{"type":"string","format":"date","title":"Date","description":"Invoice transaction date.","examples":["2022-01-01"]},"currency":{"type":"string","title":"Currency","description":"Currency code of the e-invoice.","examples":["EUR"]},"exchange_rate":{"anyOf":[{"$ref":"#/components/schemas/ExchangeRate"},{"type":"null"}],"description":"Exchange rate information if applicable."},"total_excl_tax":{"anyOf":[{"type":"number"},{"type":"string"}],"title":"Total Excl Tax","description":"Total amount excluding tax for the e-invoice.","examples":["100"]},"total_incl_tax":{"anyOf":[{"type":"number"},{"type":"string"}],"title":"Total Incl Tax","description":"Total amount including tax for the e-invoice.","examples":["121"]},"total_tax":{"anyOf":[{"type":"number"},{"type":"string"}],"title":"Total Tax","description":"Total tax amount for the e-invoice.","examples":["21"]},"custom_fields":{"type":"object","title":"Custom Fields","description":"Custom fields associated with this e-invoice."},"supplier":{"$ref":"#/components/schemas/EInvoiceCompanyInput","description":"Supplier company information."},"customer_reference_numbers":{"items":{"type":"string"},"type":"array","title":"Customer Reference Numbers","description":"Reference numbers used to match the invoice.","examples":[["12345"]]},"line_items":{"items":{"$ref":"#/components/schemas/EInvoiceLineItem"},"type":"array","title":"Line Items","description":"List of invoice lines associated with this e-invoice."},"attachments":{"anyOf":[{"items":{"$ref":"#/components/schemas/EInvoiceAttachment"},"type":"array"},{"type":"null"}],"title":"Attachments","description":"List of document attachments associated with this e-invoice."},"due_date":{"type":"string","format":"date","title":"Due Date","description":"Payment due date.","examples":["2022-01-01"]},"invoice_type":{"type":"string","const":"PURCHASE","title":"Invoice Type","description":"Indicates that this is a purchase invoice."}},"type":"object","required":["name","date","currency","total_excl_tax","total_incl_tax","total_tax","supplier","line_items","due_date","invoice_type"],"title":"PurchaseEInvoiceInput"}},"components/schemas/PurchaseInvoice":{"id":"components/schemas/PurchaseInvoice","kind":"json-schema","title":"PurchaseInvoice","data":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"Technical id within the Qargo system"},"name":{"type":"string","title":"Name","description":"Reference from invoicing party","examples":["Credit-Note-0001"]},"external_name":{"type":"string","title":"External Name","description":"Reference from invoicing party"},"date":{"type":"string","format":"date","title":"Date","examples":["2022-01-01"]},"due_date":{"type":"string","format":"date","title":"Due Date","examples":["2022-01-01"]},"booking_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Booking Date","description":"booking date needs to be enabled else this will default to the date field","examples":["2021-12-22"]},"currency":{"type":"string","title":"Currency","examples":["EUR"]},"exchange_rate":{"anyOf":[{"$ref":"#/components/schemas/ExchangeRate"},{"type":"null"}]},"total_excl_tax":{"type":"string","title":"Total Excl Tax","examples":["100"]},"total_incl_tax":{"type":"string","title":"Total Incl Tax","examples":["121"]},"total_tax":{"type":"string","title":"Total Tax","examples":["21"]},"custom_fields":{"type":"object","title":"Custom Fields","default":{}},"supplier":{"$ref":"#/components/schemas/CompanySummaryOutput"},"customer_reference_numbers":{"items":{"type":"string"},"type":"array","title":"Customer Reference Numbers","examples":[["12345"]]},"line_items":{"items":{"$ref":"#/components/schemas/LineItem"},"type":"array","title":"Line Items"},"billing_entity":{"$ref":"#/components/schemas/BillingEntity","description":"Billing entity linked to this invoice."}},"type":"object","required":["name","external_name","date","due_date","currency","total_excl_tax","total_incl_tax","total_tax","supplier","line_items","billing_entity"],"title":"PurchaseInvoice"}},"components/schemas/PurchaseInvoiceInput":{"id":"components/schemas/PurchaseInvoiceInput","kind":"json-schema","title":"PurchaseInvoiceInput","data":{"properties":{"custom_fields":{"type":"object","title":"Custom Fields","description":"User defined additional fields."}},"type":"object","title":"PurchaseInvoiceInput"}},"components/schemas/PurchaseInvoiceStatusUpdate":{"id":"components/schemas/PurchaseInvoiceStatusUpdate","kind":"json-schema","title":"PurchaseInvoiceStatusUpdate","data":{"properties":{"type":{"type":"string","const":"PurchaseInvoice","title":"Type"},"id":{"type":"string","format":"uuid","title":"Id","description":"ID of the invoice or credit note"},"status":{"$ref":"#/components/schemas/InvoiceStatus"}},"type":"object","required":["type","id","status"],"title":"PurchaseInvoiceStatusUpdate"}},"components/schemas/RawInput":{"id":"components/schemas/RawInput","kind":"json-schema","title":"RawInput","data":{"properties":{"content":{"type":"string","title":"Content","default":"base64 encoded raw data"},"mime_type":{"type":"string","title":"Mime Type","default":"mime type of content"},"filename":{"type":"string","title":"Filename","default":"Filename of content"}},"type":"object","title":"RawInput"}},"components/schemas/RefundStatus":{"id":"components/schemas/RefundStatus","kind":"json-schema","title":"RefundStatus","data":{"type":"string","enum":["OPEN","REFUNDED"],"title":"RefundStatus"}},"components/schemas/RefundStatusUpdate":{"id":"components/schemas/RefundStatusUpdate","kind":"json-schema","title":"RefundStatusUpdate","data":{"properties":{"status":{"$ref":"#/components/schemas/RefundStatus"}},"type":"object","required":["status"],"title":"RefundStatusUpdate"}},"components/schemas/RemoteDocument":{"id":"components/schemas/RemoteDocument","kind":"json-schema","title":"RemoteDocument","data":{"properties":{"download_url":{"type":"string","title":"Download Url","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In most cases the <base_url>/documents/document/"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"id","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/download endpoint"},"children":[]},{"$$mdtype":"Node","type":"error","inline":true,"errors":[{"id":"parse-error","level":"critical","message":"HTML tag <id> is not closed, opened at"}],"attributes":{},"children":[]}]}]}]}]}},"type":"object","required":["download_url"],"title":"RemoteDocument"}},"components/schemas/ResourceAllocation-Input":{"id":"components/schemas/ResourceAllocation-Input","kind":"json-schema","title":"ResourceAllocation","data":{"properties":{"resource":{"anyOf":[{"$ref":"#/components/schemas/GenericResource-Input"},{"$ref":"#/components/schemas/DriverResource-Input"},{"$ref":"#/components/schemas/ContainerResource-Input"},{"$ref":"#/components/schemas/VehicleResource-Input"}],"title":"Resource","description":"Resource assigned to the trip"}},"type":"object","required":["resource"],"title":"ResourceAllocation"}},"components/schemas/ResourceAllocation-Output":{"id":"components/schemas/ResourceAllocation-Output","kind":"json-schema","title":"ResourceAllocation","data":{"properties":{"resource":{"anyOf":[{"$ref":"#/components/schemas/GenericResource-Output"},{"$ref":"#/components/schemas/DriverResource-Output"},{"$ref":"#/components/schemas/ContainerResource-Output"},{"$ref":"#/components/schemas/VehicleResource-Output"}],"title":"Resource","description":"Resource assigned to the trip"}},"type":"object","required":["resource"],"title":"ResourceAllocation"}},"components/schemas/ResourceAllocationOutput":{"id":"components/schemas/ResourceAllocationOutput","kind":"json-schema","title":"ResourceAllocationOutput","data":{"type":"object"}},"components/schemas/ResourceExtraInput":{"id":"components/schemas/ResourceExtraInput","kind":"json-schema","title":"ResourceExtraInput","data":{"properties":{"code":{"type":"string","title":"Code","description":"Code of the stop extra. Must match exactly one extra in the tenant."}},"type":"object","required":["code"],"title":"ResourceExtraInput"}},"components/schemas/ResourceExtraOutput":{"id":"components/schemas/ResourceExtraOutput","kind":"json-schema","title":"ResourceExtraOutput","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier of the stop extra"},"code":{"type":"string","title":"Code","description":"Code of the stop extra"},"name":{"type":"string","title":"Name","description":"Name of the stop extra"}},"type":"object","required":["id","code","name"],"title":"ResourceExtraOutput"}},"components/schemas/ResourceGroupOutput":{"id":"components/schemas/ResourceGroupOutput","kind":"json-schema","title":"ResourceGroupOutput","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Identifier of the resource group."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the resource group."},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code of the resource group."}},"type":"object","required":["id"],"title":"ResourceGroupOutput"}},"components/schemas/ResourceGroupReference":{"id":"components/schemas/ResourceGroupReference","kind":"json-schema","title":"ResourceGroupReference","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Identifier of the resource group."}},"type":"object","required":["id"],"title":"ResourceGroupReference"}},"components/schemas/ResourceOutput":{"id":"components/schemas/ResourceOutput","kind":"json-schema","title":"ResourceOutput","data":{"type":"object"}},"components/schemas/ResourceType":{"id":"components/schemas/ResourceType","kind":"json-schema","title":"ResourceType","data":{"type":"string","enum":["VAN","RIGID","TRAILER","FULL_TRAILER","CONTAINER","TRACTOR","CHASSIS","COMPARTMENT","DRIVER","FERRY","TRAIN","SUBCONTRACTOR","BARGE","AIRPLANE","HANDLING"],"title":"ResourceType"}},"components/schemas/ResourceTypeEnum":{"id":"components/schemas/ResourceTypeEnum","kind":"json-schema","title":"ResourceTypeEnum","data":{"type":"string","enum":["AIRPLANE","BARGE","CHASSIS","COMPARTMENT","CONTAINER","DRIVER","FERRY","FULL_TRAILER","HANDLING","RIGID","SUBCONTRACTOR","TRACTOR","TRAILER","TRAIN","VAN"],"title":"ResourceTypeEnum"}},"components/schemas/ResourceUnavailabilityInput":{"id":"components/schemas/ResourceUnavailabilityInput","kind":"json-schema","title":"ResourceUnavailabilityInput","data":{"properties":{"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":"External identifier of the unavailability"},"start_time":{"type":"string","format":"date-time","title":"Start Time","description":"Start time of the unavailability"},"end_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Time","description":"End time of the unavailability, leave empty for open interval"},"reason":{"$ref":"#/components/schemas/UnavailabilityReason"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"}},"type":"object","required":["start_time","reason"],"title":"ResourceUnavailabilityInput"}},"components/schemas/ResourceUnavailabilityOutput":{"id":"components/schemas/ResourceUnavailabilityOutput","kind":"json-schema","title":"ResourceUnavailabilityOutput","data":{"properties":{"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":"External identifier of the unavailability"},"start_time":{"type":"string","format":"date-time","title":"Start Time","description":"Start time of the unavailability"},"end_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Time","description":"End time of the unavailability, leave empty for open interval"},"reason":{"$ref":"#/components/schemas/UnavailabilityReason"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier of the unavailability"}},"type":"object","required":["start_time","reason","id"],"title":"ResourceUnavailabilityOutput"}},"components/schemas/ResourceUpdate":{"id":"components/schemas/ResourceUpdate","kind":"json-schema","title":"ResourceUpdate","data":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id"},"type":{"type":"string","const":"Resource","title":"Type"},"resource":{"$ref":"#/components/schemas/VisibilityResource"},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Custom Fields"}},"type":"object","required":["type","resource"],"title":"ResourceUpdate","description":"Send update event on resource assignment (allocation).\n\nNot that by default, we can send updates on every resource assignment change.\nThis can be customised to only send an update at the moment that the transport\nis dispatched to the driver or subcontractor."}},"components/schemas/ResourceValidityInput":{"id":"components/schemas/ResourceValidityInput","kind":"json-schema","title":"ResourceValidityInput","data":{"properties":{"start_time":{"type":"string","format":"date-time","title":"Start Time","description":"Start time of the validity"},"end_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Time","description":"End time of the validity from a planning perspective"},"legal_end_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Legal End Time","description":"End time of the validity from a legal perspective"},"generate_unavailability":{"type":"boolean","title":"Generate Unavailability","description":"Generate a planning unavailability once the validity end time has passed","default":false},"type":{"$ref":"#/components/schemas/ResourceValidityReason"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":"ID of the validity in the external master data system"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"documents":{"items":{"$ref":"#/components/schemas/UploadedDocumentBase_Union_ContainerDocumentTypes__DriverDocumentTypes__VehicleDocumentTypes__"},"type":"array","title":"Documents","description":"List of documents associated with the validity"}},"type":"object","required":["start_time","type"],"title":"ResourceValidityInput"}},"components/schemas/ResourceValidityOutput":{"id":"components/schemas/ResourceValidityOutput","kind":"json-schema","title":"ResourceValidityOutput","data":{"properties":{"start_time":{"type":"string","format":"date-time","title":"Start Time","description":"Start time of the validity"},"end_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Time","description":"End time of the validity from a planning perspective"},"legal_end_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Legal End Time","description":"End time of the validity from a legal perspective"},"generate_unavailability":{"type":"boolean","title":"Generate Unavailability","description":"Generate a planning unavailability once the validity end time has passed","default":false},"type":{"$ref":"#/components/schemas/ResourceValidityReason"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":"ID of the validity in the external master data system"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier of the validity"}},"type":"object","required":["start_time","type","id"],"title":"ResourceValidityOutput"}},"components/schemas/ResourceValidityReason":{"id":"components/schemas/ResourceValidityReason","kind":"json-schema","title":"ResourceValidityReason","data":{"type":"string","enum":["EUROVIGNET","FUEL_CARD","FINE","CONTAINER_CERTIFICATE","CONTAINER_DAMAGE_REPORT","CONTAINER_INSPECTION_REPORT","CONTAINER_LEASE","CONTAINER_MAINTENANCE_REPORT","CONTAINER_REPAIR_REPORT","CONTAINER_TANK_TEST_CERTIFICATE_2Y5","CONTAINER_TANK_TEST_CERTIFICATE_5Y","CONTAINER_TANK_TEST_CERTIFICATE","DRIVER_ADR_EXTRA_TRAINING","DRIVER_ADR_LICENSE","DRIVER_AEO_REGULATED_AGENT_LICENSE","DRIVER_CARD","DRIVER_CIVIL_LIABILITY_EXPLOITATION","DRIVER_CIVIL_LIABILITY_INSURANCE","DRIVER_CODE_95","DRIVER_DRIVING_LICENSE","DRIVER_IDENTITY_CARD","DRIVER_IMI_PORTAL","DRIVER_INSURANCE","DRIVER_MEDICAL_EXAM","DRIVER_PERSONAL_PROTECTIVE_EQUIPMENT","DRIVER_RECUP","DRIVER_REFUGEE_TRAINING_LICENSE","DRIVER_SHIFT_PATTERN","DRIVER_SICK_NOTE","DRIVER_TRAINING","BBS_CERTIFICATE","FORKLIFT_LICENSE","PAYSCALE_DRIVER","VCA_BASIC_SAFETY","TOLL_CARD","SAFETY_CERTIFICATE_TERMINAL","EXCEPTIONAL_TRANSPORT_LICENSE","A1_DOCUMENT","DRIVER_CPC_CARD","DRIVER_POSTING_DOCUMENT","SITE_MOVEMENT_SHEET","DRIVER_PARENTAL_LEAVE","DRIVER_JOB_APPLICATION_LEAVE","DRIVER_PUBLIC_HOLIDAY","DRIVER_SOCIAL_LEAVE","DRIVER_UNION_LEAVE","DRIVER_LONG_HEAVY_VEHICLE_CERT","DRIVER_CARGOCARD_ACCESS_CARD","DRIVER_ALFAPASS","DRIVER_OFF_SHIFT_PATTERN","DRIVER_REDUCED_WORKING_HOURS_SCHEME","DRIVER_UNAUTHORISED_ABSENCE","VEHICLE_MOT_TEST","VEHICLE_REGISTRATION","VEHICLE_INSURANCE_CERTIFICATE","VEHICLE_TRANSPORT_LICENSE","VEHICLE_DAMAGE_REPORT","VEHICLE_MAINTENANCE_REPORT","VEHICLE_ADR_CERTIFICATE","VEHICLE_REPAIR_REPORT","VEHICLE_TACHO","VEHICLE_TIR","VEHICLE_PHOTO","VEHICLE_12_WEEKLY_CHECK","VEHICLE_FIRE_EXTINGUISHER_SERVICE","VEHICLE_UK_HGV_LEVY","VEHICLE_ATP_CERTIFICATE","VEHICLE_FRIDGE_MOTOR","OVERSIZE_WL_PERMIT","ROADTAX","CERTIFICATE_OF_CONFORMITY","BRAKE_TEST_CERTIFICATE","BREAK_TEST_CERTIFICATE","VEHICLE_IDENTIFICATION_REPORT","VEHICLE_FRC_CERTIFICATE","VEHICLE_GERMAN_SECURITY_INSPECTION","VEHICLE_GERMAN_VEHICLE_INSPECTION","CITERNE_CLEANING_CERTIFICATE","HEAVY_LOAD_BE","HEAVY_LOAD_DE","HEAVY_LOAD_FR","XL_CERTIFICATE","VEHICLE_SERVICE","VEHICLE_HIRE","VEHICLE_BRAKE_TEST","VEHICLE_HYDRAULIC_INSPECTION","VEHICLE_LIFT_OPS_EQUIP_REGULATIONS","VEHICLE_PRESSURE_TEST","VEHICLE_TACHOGRAPH_CALIBRATION"],"title":"ResourceValidityReason"}},"components/schemas/SalesCompanyFields-Input":{"id":"components/schemas/SalesCompanyFields-Input","kind":"json-schema","title":"SalesCompanyFields","data":{"properties":{"payment_term":{"anyOf":[{"$ref":"#/components/schemas/BasePaymentTerm"},{"type":"null"}],"description":"Payment term information of the company"},"billing_entities":{"anyOf":[{"items":{"$ref":"#/components/schemas/CompanyBillingEntity"},"type":"array"},{"type":"null"}],"title":"Billing Entities","description":"List of billing entities associated with the company"},"status":{"anyOf":[{"$ref":"#/components/schemas/CustomerStatus"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status indicates whether an order can be linked to this customer. The available statuses are:"},"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":"code","inline":true,"attributes":{"content":"PROSPECT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The company is a potential customer but not yet approved. Only quotes can be created; no orders can be placed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT_APPROVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The company is not yet fully approved as a customer. This is an intermediary step between PROSPECT and APPROVED. Same permissions as PROSPECT apply."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPROVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The customer is approved. Orders can be placed without restrictions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WARNING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The customer is approved, but a warning is triggered when attempting to create an order  in Qargo. The operator can dismiss the warning and proceed with the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BLOCKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The customer is blocked; no new orders can be created."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a company representing other companies, it can only create orders if it holds the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPROVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]}]}]}],"default":"APPROVED","examples":["APPROVED"]}},"type":"object","title":"SalesCompanyFields"}},"components/schemas/SalesCompanyFields-Output":{"id":"components/schemas/SalesCompanyFields-Output","kind":"json-schema","title":"SalesCompanyFields","data":{"properties":{"payment_term":{"anyOf":[{"$ref":"#/components/schemas/BasePaymentTerm"},{"type":"null"}],"description":"Payment term information of the company"},"billing_entities":{"anyOf":[{"items":{"$ref":"#/components/schemas/CompanyBillingEntity"},"type":"array"},{"type":"null"}],"title":"Billing Entities","description":"List of billing entities associated with the company"},"status":{"anyOf":[{"$ref":"#/components/schemas/CustomerStatus"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status indicates whether an order can be linked to this customer. The available statuses are:"},"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":"code","inline":true,"attributes":{"content":"PROSPECT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The company is a potential customer but not yet approved. Only quotes can be created; no orders can be placed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT_APPROVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The company is not yet fully approved as a customer. This is an intermediary step between PROSPECT and APPROVED. Same permissions as PROSPECT apply."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPROVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The customer is approved. Orders can be placed without restrictions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WARNING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The customer is approved, but a warning is triggered when attempting to create an order  in Qargo. The operator can dismiss the warning and proceed with the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BLOCKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The customer is blocked; no new orders can be created."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a company representing other companies, it can only create orders if it holds the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPROVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]}]}]}],"default":"APPROVED","examples":["APPROVED"]}},"type":"object","title":"SalesCompanyFields"}},"components/schemas/SalesCreditNoteInput":{"id":"components/schemas/SalesCreditNoteInput","kind":"json-schema","title":"SalesCreditNoteInput","data":{"properties":{"date":{"type":"string","format":"date","title":"Date","description":"Credit note date","examples":["2022-01-01"]},"booking_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Booking Date","description":"booking date needs to be enabled else this will default to the date field","examples":["2021-12-22"]},"currency":{"type":"string","title":"Currency","examples":["EUR"]},"custom_fields":{"type":"object","title":"Custom Fields","default":{}},"customer_reference_numbers":{"items":{"type":"string"},"type":"array","title":"Customer Reference Numbers","examples":[["12345"]]},"customer":{"$ref":"#/components/schemas/CustomerReference","description":"Customer reference for this credit note."},"charges":{"items":{"$ref":"#/components/schemas/ChargeInput"},"type":"array","title":"Charges"},"billing_entity":{"anyOf":[{"$ref":"#/components/schemas/BillingEntityReference"},{"type":"null"}],"description":"Billing entity linked to this credit note. When having multiple billing entities make sure to specify the correct entity."}},"type":"object","required":["date","currency","customer","charges"],"title":"SalesCreditNoteInput"}},"components/schemas/SalesCreditNoteOutput":{"id":"components/schemas/SalesCreditNoteOutput","kind":"json-schema","title":"SalesCreditNoteOutput","data":{"properties":{"date":{"type":"string","format":"date","title":"Date","description":"Credit note date","examples":["2022-01-01"]},"booking_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Booking Date","description":"booking date needs to be enabled else this will default to the date field","examples":["2021-12-22"]},"currency":{"type":"string","title":"Currency","examples":["EUR"]},"custom_fields":{"type":"object","title":"Custom Fields","default":{}},"customer_reference_numbers":{"items":{"type":"string"},"type":"array","title":"Customer Reference Numbers","examples":[["12345"]]},"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"Technical id within the Qargo system"},"name":{"type":"string","title":"Name","examples":["Credit-Note-0001"]},"e_invoicing":{"anyOf":[{"$ref":"#/components/schemas/EInvoicingOutput"},{"type":"null"}],"description":"E-invoicing registration metadata."},"exchange_rate":{"anyOf":[{"$ref":"#/components/schemas/ExchangeRate"},{"type":"null"}]},"total_excl_tax":{"type":"string","title":"Total Excl Tax","examples":["100"]},"total_incl_tax":{"type":"string","title":"Total Incl Tax","examples":["121"]},"total_tax":{"type":"string","title":"Total Tax","examples":["21"]},"customer":{"$ref":"#/components/schemas/CompanySummaryOutput"},"line_items":{"items":{"$ref":"#/components/schemas/LineItem"},"type":"array","title":"Line Items"},"billing_entity":{"$ref":"#/components/schemas/BillingEntity","description":"Billing entity linked to this credit note."}},"type":"object","required":["date","currency","id","name","total_excl_tax","total_incl_tax","total_tax","customer","line_items","billing_entity"],"title":"SalesCreditNoteOutput"}},"components/schemas/SalesCreditNotePatchInput":{"id":"components/schemas/SalesCreditNotePatchInput","kind":"json-schema","title":"SalesCreditNotePatchInput","data":{"properties":{"custom_fields":{"type":"object","title":"Custom Fields","description":"User defined additional fields."}},"type":"object","title":"SalesCreditNotePatchInput"}},"components/schemas/SalesCreditNoteStatusUpdate":{"id":"components/schemas/SalesCreditNoteStatusUpdate","kind":"json-schema","title":"SalesCreditNoteStatusUpdate","data":{"properties":{"type":{"type":"string","const":"SalesCreditNote","title":"Type"},"id":{"type":"string","format":"uuid","title":"Id","description":"ID of the invoice or credit note"},"status":{"$ref":"#/components/schemas/CreditNoteStatus"}},"type":"object","required":["type","id","status"],"title":"SalesCreditNoteStatusUpdate"}},"components/schemas/SalesInvoiceInput":{"id":"components/schemas/SalesInvoiceInput","kind":"json-schema","title":"SalesInvoiceInput","data":{"properties":{"date":{"type":"string","format":"date","title":"Date","description":"Invoicing date","examples":["2022-01-01"]},"due_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Due Date","examples":["2022-01-01"]},"booking_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Booking Date","description":"booking date needs to be enabled else this will default to the date field","examples":["2021-12-22"]},"currency":{"type":"string","title":"Currency","description":"Currency code (ISO 4217).","examples":["EUR"]},"customer_reference_numbers":{"items":{"type":"string"},"type":"array","title":"Customer Reference Numbers","description":"PO numbers","default":[],"examples":[["12345"]]},"custom_fields":{"type":"object","title":"Custom Fields","default":{}},"customer":{"$ref":"#/components/schemas/CustomerReference"},"charges":{"items":{"$ref":"#/components/schemas/ChargeInput"},"type":"array","title":"Charges"},"billing_entity":{"anyOf":[{"$ref":"#/components/schemas/BillingEntityReference"},{"type":"null"}],"description":"Billing entity linked to this invoice. When having multiple billing entities make sure to specify the correct entity."}},"type":"object","required":["date","currency","customer","charges"],"title":"SalesInvoiceInput"}},"components/schemas/SalesInvoiceMatch":{"id":"components/schemas/SalesInvoiceMatch","kind":"json-schema","title":"SalesInvoiceMatch","data":{"properties":{"name":{"anyOf":[{"$ref":"#/components/schemas/FieldMatchInput"},{"type":"null"}]}},"type":"object","title":"SalesInvoiceMatch"}},"components/schemas/SalesInvoiceOutput":{"id":"components/schemas/SalesInvoiceOutput","kind":"json-schema","title":"SalesInvoiceOutput","data":{"properties":{"date":{"type":"string","format":"date","title":"Date","description":"Invoicing date","examples":["2022-01-01"]},"due_date":{"type":"string","format":"date","title":"Due Date","examples":["2022-01-01"]},"booking_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Booking Date","description":"booking date needs to be enabled else this will default to the date field","examples":["2021-12-22"]},"currency":{"type":"string","title":"Currency","description":"Currency code (ISO 4217).","examples":["EUR"]},"customer_reference_numbers":{"items":{"type":"string"},"type":"array","title":"Customer Reference Numbers","description":"PO numbers","default":[],"examples":[["12345"]]},"custom_fields":{"type":"object","title":"Custom Fields","default":{}},"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"Technical id within the Qargo system"},"name":{"type":"string","title":"Name","description":"Name of the invoice.","examples":["Invoice-0001"]},"e_invoicing":{"anyOf":[{"$ref":"#/components/schemas/EInvoicingOutput"},{"type":"null"}],"description":"E-invoicing registration metadata."},"exchange_rate":{"anyOf":[{"$ref":"#/components/schemas/ExchangeRate"},{"type":"null"}]},"total_excl_tax":{"type":"string","title":"Total Excl Tax","examples":["100"]},"total_incl_tax":{"type":"string","title":"Total Incl Tax","examples":["121"]},"total_tax":{"type":"string","title":"Total Tax","examples":["21"]},"customer":{"$ref":"#/components/schemas/CompanySummaryOutput"},"line_items":{"items":{"$ref":"#/components/schemas/LineItem"},"type":"array","title":"Line Items"},"billing_entity":{"$ref":"#/components/schemas/BillingEntity","description":"Billing entity linked to this invoice."}},"type":"object","required":["date","due_date","currency","id","name","total_excl_tax","total_incl_tax","total_tax","customer","line_items","billing_entity"],"title":"SalesInvoiceOutput"}},"components/schemas/SalesInvoicePatchInput":{"id":"components/schemas/SalesInvoicePatchInput","kind":"json-schema","title":"SalesInvoicePatchInput","data":{"properties":{"custom_fields":{"type":"object","title":"Custom Fields","description":"User defined additional fields."}},"type":"object","title":"SalesInvoicePatchInput"}},"components/schemas/SalesInvoiceStatusUpdate":{"id":"components/schemas/SalesInvoiceStatusUpdate","kind":"json-schema","title":"SalesInvoiceStatusUpdate","data":{"properties":{"type":{"type":"string","const":"SalesInvoice","title":"Type"},"id":{"type":"string","format":"uuid","title":"Id","description":"ID of the invoice or credit note"},"status":{"$ref":"#/components/schemas/InvoiceStatus"}},"type":"object","required":["type","id","status"],"title":"SalesInvoiceStatusUpdate"}},"components/schemas/SalesInvoiceUpdate":{"id":"components/schemas/SalesInvoiceUpdate","kind":"json-schema","title":"SalesInvoiceUpdate","data":{"properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Custom Fields"},"match":{"$ref":"#/components/schemas/BillingDocumentMatchTarget","description":"Matcher for the billing document update, used to match to a billing document"}},"type":"object","title":"SalesInvoiceUpdate"}},"components/schemas/ServiceLevel":{"id":"components/schemas/ServiceLevel","kind":"json-schema","title":"ServiceLevel","data":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Human readable identifier"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Machine readable identifier"},"custom_fields":{"type":"object","title":"Custom Fields","description":"Store values for user defined fields"}},"type":"object","title":"ServiceLevel"}},"components/schemas/Shipment":{"id":"components/schemas/Shipment","kind":"json-schema","title":"Shipment","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier for shipment"},"custom_fields":{"type":"object","title":"Custom Fields","description":"Store values for user defined fields"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Human readable identifier"},"orders":{"anyOf":[{"items":{"$ref":"#/components/schemas/OrderOutput-Output"},"type":"array"},{"type":"null"}],"title":"Orders","description":"List of orders in the shipment"},"shipment_planning_group":{"anyOf":[{"$ref":"#/components/schemas/PlanningGroup"},{"type":"null"}],"description":"Planning group linked to shipment"},"stops":{"anyOf":[{"items":{"$ref":"#/components/schemas/StopOutput-Output"},"type":"array"},{"type":"null"}],"title":"Stops","description":"List of stops in the shipment"},"metrics":{"anyOf":[{"$ref":"#/components/schemas/OrderMetrics"},{"type":"null"}],"description":"Metrics related to the shipment"},"resource_allocations":{"anyOf":[{"items":{"$ref":"#/components/schemas/ResourceAllocation-Output"},"type":"array"},{"type":"null"}],"title":"Resource Allocations","description":"List of resources assigned to the shipment"},"resource_allocations_by_type":{"anyOf":[{"additionalProperties":{"items":{"$ref":"#/components/schemas/ResourceAllocation-Output"},"type":"array"},"type":"object"},{"type":"null"}],"title":"Resource Allocations By Type","description":"List of resource allocations by type"}},"type":"object","required":["id"],"title":"Shipment"}},"components/schemas/ShippeoOrderInput":{"id":"components/schemas/ShippeoOrderInput","kind":"json-schema","title":"ShippeoOrderInput","data":{"properties":{"external_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Reference"}},"type":"object","title":"ShippeoOrderInput"}},"components/schemas/ShippingCompany":{"id":"components/schemas/ShippingCompany","kind":"json-schema","title":"ShippingCompany","data":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Human readable identifier"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Machine readable identifier"}},"type":"object","title":"ShippingCompany"}},"components/schemas/ShippingLocation":{"id":"components/schemas/ShippingLocation","kind":"json-schema","title":"ShippingLocation","data":{"properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Technical code for integrations/mapping logic; should be treated as stable once set.","examples":["LOC123"]},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name","description":"Human-readable label for a location in operational views.","examples":["Main Office"]},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":"Identifier from an external (master data) system."},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address","description":"First address line of the location","examples":["Gaston Crommenlaan 4"]},"address_second_line":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address Second Line","description":"Second address line of the location","examples":[""]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City of the location","examples":["Ghent"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State of the location","examples":[""]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code (ISO 3166-1 alpha-2) of the location","examples":["BE"]},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Postal Code","description":"Postal code of the location","examples":["9050"]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the location","examples":["Qargo HQ"]},"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"Identifier of the location"},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Latitude"},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Longitude"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Location description"},"location_identifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location Identifier","description":"External location identifier"},"terminal_metadata":{"anyOf":[{"$ref":"#/components/schemas/TerminalMetadata"},{"type":"null"}],"description":"Metadata about the terminal."}},"type":"object","title":"ShippingLocation"}},"components/schemas/ShippingRoute":{"id":"components/schemas/ShippingRoute","kind":"json-schema","title":"ShippingRoute","data":{"properties":{"start_stop":{"$ref":"#/components/schemas/ShippingStop","description":"Origin stop of the route."},"end_stop":{"$ref":"#/components/schemas/ShippingStop","description":"Destination stop of the route."},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Shipping route code. Optional when location details are not available."},"modality":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Modality","description":"Transport modality of the route. One of: RAIL, FERRY, BARGE, AIR.","examples":["RAIL"]},"custom_fields":{"type":"object","title":"Custom Fields","description":"Values for user-defined fields on the route."}},"type":"object","required":["start_stop","end_stop"],"title":"ShippingRoute"}},"components/schemas/ShippingStop":{"id":"components/schemas/ShippingStop","kind":"json-schema","title":"ShippingStop","data":{"properties":{"location":{"$ref":"#/components/schemas/ShippingLocation"},"reference_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference Number","description":"Reference number for the stop."},"timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time of the stop. Required for the route's start stop (ISO 8601 format with a timezone offset, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+02:00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"examples":["2024-12-31T08:00:00Z"]}},"type":"object","required":["location"],"title":"ShippingStop"}},"components/schemas/Signature":{"id":"components/schemas/Signature","kind":"json-schema","title":"Signature","data":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the person who signed"},"position":{"anyOf":[{"$ref":"#/components/schemas/Position"},{"type":"null"}],"description":"Position data where the signature was captured"},"timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp","description":"Timestamp when the signature was captured"},"type":{"$ref":"#/components/schemas/SignatureType","description":"Type of the signature"}},"type":"object","required":["type"],"title":"Signature"}},"components/schemas/SignatureInput":{"id":"components/schemas/SignatureInput","kind":"json-schema","title":"SignatureInput","data":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp"},"position":{"anyOf":[{"$ref":"#/components/schemas/Position"},{"type":"null"}]}},"type":"object","title":"SignatureInput"}},"components/schemas/SignatureType":{"id":"components/schemas/SignatureType","kind":"json-schema","title":"SignatureType","data":{"type":"string","enum":["CONSIGNOR","CONSIGNEE","DRIVER"],"title":"SignatureType"}},"components/schemas/StopActivityConfigInput":{"id":"components/schemas/StopActivityConfigInput","kind":"json-schema","title":"StopActivityConfigInput","data":{"properties":{"resource_types":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Resource Types"},"dpc_start_or_end_stop_location":{"anyOf":[{"$ref":"#/components/schemas/LocationInput"},{"type":"null"}]},"dpc_drop_collect_empty_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Dpc Drop Collect Empty Date"},"duration":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Duration"}},"type":"object","title":"StopActivityConfigInput"}},"components/schemas/StopActivityInput":{"id":"components/schemas/StopActivityInput","kind":"json-schema","title":"StopActivityInput","data":{"properties":{"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"},"config":{"anyOf":[{"$ref":"#/components/schemas/StopActivityConfigInput"},{"type":"null"}]}},"type":"object","title":"StopActivityInput"}},"components/schemas/StopData":{"id":"components/schemas/StopData","kind":"json-schema","title":"StopData","data":{"properties":{"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note"},"date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date"},"reference_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference Number"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number"},"mobile_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mobile Number"},"planning_instructions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Planning Instructions"},"location":{"anyOf":[{"$ref":"#/components/schemas/LocationInput"},{"type":"null"}]},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Custom Fields"},"extras":{"anyOf":[{"items":{"type":"object"},"type":"array"},{"type":"null"}],"title":"Extras"},"time_window":{"anyOf":[{"$ref":"#/components/schemas/TimeWindowInput"},{"type":"null"}]},"position":{"anyOf":[{"$ref":"#/components/schemas/StopPosition"},{"type":"null"}]},"stop_type":{"anyOf":[{"$ref":"#/components/schemas/StopTypeField"},{"type":"null"}]},"stop_activity":{"anyOf":[{"$ref":"#/components/schemas/StopActivityInput"},{"type":"null"}]},"drop_collect_empty":{"anyOf":[{"$ref":"#/components/schemas/UpdateDropCollectEmptyInput"},{"type":"null"}]},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id"}},"type":"object","title":"StopData"}},"components/schemas/StopDepotOutput":{"id":"components/schemas/StopDepotOutput","kind":"json-schema","title":"StopDepotOutput","data":{"properties":{"load_sequence_number":{"anyOf":[{"type":"integer","exclusiveMinimum":0},{"type":"null"}],"title":"Load Sequence Number","description":"Load sequence number for the stop"},"unload_timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Unload Timestamp","description":"Timestamp for which the delivery is scheduled. ISO 8601 format in UTC.","examples":["2024-12-31T14:30:00Z"]},"unload_sequence_number":{"anyOf":[{"type":"integer","exclusiveMinimum":0},{"type":"null"}],"title":"Unload Sequence Number","description":"Unload sequence number for the stop"},"load_timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Load Timestamp","description":"Timestamp for which the pickup is scheduled. ISO 8601 format in UTC.","examples":["2024-12-31T08:00:00Z"]},"load_planned":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Load Planned","description":"Indicates if the load is planned for this stop"},"unload_planned":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Unload Planned","description":"Indicates if the unload is planned for this stop"},"load_pickup_stop_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Load Pickup Stop Id","description":"Identifier of the pickup stop related to the load"},"unload_delivery_stop_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Unload Delivery Stop Id","description":"Identifier of the delivery stop related to the unload"}},"type":"object","title":"StopDepotOutput"}},"components/schemas/StopEntityUpdate":{"id":"components/schemas/StopEntityUpdate","kind":"json-schema","title":"StopEntityUpdate","data":{"properties":{"operation":{"type":"string","enum":["CREATE","UPDATE","DELETE"],"title":"Operation"},"data":{"anyOf":[{"$ref":"#/components/schemas/StopUpdateData"},{"$ref":"#/components/schemas/StopData"},{"type":"null"}],"title":"Data"}},"type":"object","required":["operation"],"title":"StopEntityUpdate"}},"components/schemas/StopExtra":{"id":"components/schemas/StopExtra","kind":"json-schema","title":"StopExtra","data":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","default":""},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","default":""},"amazon":{"anyOf":[{"$ref":"#/components/schemas/AmazonExtraFields"},{"type":"null"}]},"custom_fields":{"type":"object","title":"Custom Fields","description":"Store values for user defined fields"}},"type":"object","title":"StopExtra"}},"components/schemas/StopGroup":{"id":"components/schemas/StopGroup","kind":"json-schema","title":"StopGroup","data":{"properties":{"id":{"type":"string","title":"Id","description":"ID of the stop group"},"templates":{"items":{"$ref":"#/components/schemas/StopGroupTemplate"},"type":"array","title":"Templates","description":"List of templates to be rendered on the fleet device"},"main_activity":{"type":"string","title":"Main Activity","description":"Activity of the fleet app that is linked to this stop group"},"stops":{"items":{"$ref":"#/components/schemas/StopGroupStop"},"type":"array","title":"Stops","description":"List of stops in the stop group"},"location":{"$ref":"#/components/schemas/LocationOutput","description":"Location of the stop group"},"start_timestamp":{"type":"string","format":"date-time","title":"Start Timestamp","description":"Start timestamp of the stop group"},"end_timestamp":{"type":"string","format":"date-time","title":"End Timestamp","description":"End timestamp of the stop group"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes","description":"Notes for the stop group"}},"type":"object","required":["id","templates","main_activity","stops","location","start_timestamp","end_timestamp"],"title":"StopGroup"}},"components/schemas/StopGroupStatusUpdate":{"id":"components/schemas/StopGroupStatusUpdate","kind":"json-schema","title":"StopGroupStatusUpdate","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"ID of the stop group (from the original order/trip)"},"status":{"anyOf":[{"$ref":"#/components/schemas/StopStatusUpdateEnum"},{"type":"null"}],"description":"Updated status of the stop group. All stops in the stop group will updated with this status."},"question_answers":{"type":"object","title":"Question Answers","description":"Data related to the status update. This data can be mapped to different entities in Qargo."},"eta_start":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Eta Start","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Estimated arrival time (ETA) at the stop group in UTC. Include a timezone offset, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+02:00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"eta_end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Eta End","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Estimated departure time (ETD) from the stop group in UTC. Include a timezone offset, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+02:00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"type":"object","required":["id"],"title":"StopGroupStatusUpdate","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a stop group from an external source."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can update status and data of the stops in a stop group. Updates on the data happen based on the defined"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integration_data_mapping in the integration configuration."},"children":[]}]}]}]}},"components/schemas/StopGroupStop":{"id":"components/schemas/StopGroupStop","kind":"json-schema","title":"StopGroupStop","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"ID of the stop group"},"date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date","description":"Date of the stop group"},"start_timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Timestamp","description":"Start timestamp of the stop group"},"end_timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Timestamp","description":"End timestamp of the stop group"}},"type":"object","required":["id"],"title":"StopGroupStop"}},"components/schemas/StopGroupTemplate":{"id":"components/schemas/StopGroupTemplate","kind":"json-schema","title":"StopGroupTemplate","data":{"properties":{"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title","description":"Title to be displayed on fleet app"},"subtitle":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subtitle","description":"Subtitle to be displayed on fleet app"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Text to be displayed on fleet app"}},"type":"object","title":"StopGroupTemplate"}},"components/schemas/StopInput-Input":{"id":"components/schemas/StopInput-Input","kind":"json-schema","title":"StopInput","data":{"properties":{"activity_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Activity Label","description":"Activity to execute at this location, ie. pickup/collect, couple/uncouple trailer"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"Additional freeform data for this stop"},"reference_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"stop reference number"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number"},"mobile_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mobile Number"},"time_window":{"anyOf":[{"$ref":"#/components/schemas/TimeWindow"},{"type":"null"}],"title":"time_window"},"planning_instructions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Planning Instructions","description":"Additional freeform instructions for the planner."},"extras":{"anyOf":[{"items":{"$ref":"#/components/schemas/StopExtra"},"type":"array"},{"type":"null"}],"title":"Extras","description":"Additional services/options for stop"},"custom_fields":{"type":"object","title":"Custom Fields","description":"Additional user defined fields to fill in"},"date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date","description":"Date on which stop happens. Optional for delivery stops when a service level is set on the order","examples":["2024-12-31"]},"custom_activity_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Custom Activity Label","description":"Custom activity related to the order"},"duration":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Duration","description":"Duration of the stop in seconds"},"location":{"$ref":"#/components/schemas/Location","description":"Location of the stop"},"drop_collect_empty":{"anyOf":[{"$ref":"#/components/schemas/DropCollectEmptyInput"},{"type":"null"}],"description":"Information for drop/collect empty stops"}},"type":"object","required":["location"],"title":"StopInput"}},"components/schemas/StopInput-Output":{"id":"components/schemas/StopInput-Output","kind":"json-schema","title":"StopInput","data":{"properties":{"activity_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Activity Label","description":"Activity to execute at this location, ie. pickup/collect, couple/uncouple trailer"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"Additional freeform data for this stop"},"reference_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"stop reference number"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number"},"mobile_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mobile Number"},"time_window":{"anyOf":[{"$ref":"#/components/schemas/TimeWindow"},{"type":"null"}],"title":"time_window"},"planning_instructions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Planning Instructions","description":"Additional freeform instructions for the planner."},"extras":{"anyOf":[{"items":{"$ref":"#/components/schemas/StopExtra"},"type":"array"},{"type":"null"}],"title":"Extras","description":"Additional services/options for stop"},"custom_fields":{"type":"object","title":"Custom Fields","description":"Additional user defined fields to fill in"},"date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date","description":"Date on which stop happens. Optional for delivery stops when a service level is set on the order","examples":["2024-12-31"]},"custom_activity_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Custom Activity Label","description":"Custom activity related to the order"},"duration":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Duration","description":"Duration of the stop in seconds"},"location":{"$ref":"#/components/schemas/Location","description":"Location of the stop"},"drop_collect_empty":{"anyOf":[{"$ref":"#/components/schemas/DropCollectEmptyInput"},{"type":"null"}],"description":"Information for drop/collect empty stops"}},"type":"object","required":["location"],"title":"StopInput"}},"components/schemas/StopInsertPosition":{"id":"components/schemas/StopInsertPosition","kind":"json-schema","title":"StopInsertPosition","data":{"properties":{"position":{"anyOf":[{"type":"integer","exclusiveMinimum":0},{"type":"null"}],"title":"Position","description":"Position of the stop in the order. Needs to be an positive non-zero integer"}},"type":"object","title":"StopInsertPosition"}},"components/schemas/StopMatch":{"id":"components/schemas/StopMatch","kind":"json-schema","title":"StopMatch","data":{"properties":{"reference_number":{"anyOf":[{"$ref":"#/components/schemas/FieldMatchInput"},{"type":"null"}]},"stop_type":{"anyOf":[{"$ref":"#/components/schemas/StopType"},{"type":"null"}]},"leg":{"anyOf":[{"$ref":"#/components/schemas/LegMatch"},{"type":"null"}]}},"type":"object","title":"StopMatch"}},"components/schemas/StopMatchInput":{"id":"components/schemas/StopMatchInput","kind":"json-schema","title":"StopMatchInput","data":{"properties":{"trip":{"anyOf":[{"$ref":"#/components/schemas/TripMatch"},{"type":"null"}]},"order":{"anyOf":[{"$ref":"#/components/schemas/OrderMatch"},{"type":"null"}]},"consignment":{"anyOf":[{"$ref":"#/components/schemas/ConsignmentMatch"},{"type":"null"}]},"stop":{"anyOf":[{"$ref":"#/components/schemas/StopMatch"},{"type":"null"}]}},"type":"object","title":"StopMatchInput"}},"components/schemas/StopMatchTarget":{"id":"components/schemas/StopMatchTarget","kind":"json-schema","title":"StopMatchTarget","data":{"properties":{"matches_all":{"items":{"$ref":"#/components/schemas/StopMatchInput"},"type":"array","title":"Matches All"}},"type":"object","title":"StopMatchTarget"}},"components/schemas/StopOutput-Input":{"id":"components/schemas/StopOutput-Input","kind":"json-schema","title":"StopOutput","data":{"properties":{"activity_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Activity Label","description":"Activity to execute at this location, ie. pickup/collect, couple/uncouple trailer"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"Additional freeform data for this stop"},"reference_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"stop reference number"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number"},"mobile_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mobile Number"},"time_window":{"anyOf":[{"$ref":"#/components/schemas/TimeWindow"},{"type":"null"}],"title":"time_window"},"planning_instructions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Planning Instructions","description":"Additional freeform instructions for the planner."},"extras":{"anyOf":[{"items":{"$ref":"#/components/schemas/StopExtra"},"type":"array"},{"type":"null"}],"title":"Extras","description":"Additional services/options for stop"},"custom_fields":{"type":"object","title":"Custom Fields","description":"Additional user defined fields to fill in"},"date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date","description":"Requested date of the stop, as shown in the planning UI. Empty for stops without a requested date (e.g. standalone stops).","examples":["2024-12-31"]},"depot":{"anyOf":[{"$ref":"#/components/schemas/StopDepotOutput"},{"type":"null"}],"description":"Depot information for the stop. Only relevant for location bookings (load building)."},"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier for stop"},"location":{"$ref":"#/components/schemas/LocationWithTerminalOutput-Input","description":"Location of the stop"},"mileage_km":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Mileage Km","description":"Mileage in kilometers"},"end_timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Timestamp","description":"End of stop. The value depends on the stop status: the estimated end time until the stop reaches status COMPLETED, after which it is the actual end time reported during execution. ISO 8601 format in UTC.","examples":["2024-12-31T08:15:00Z"]},"start_timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Timestamp","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start of stop. The value depends on the stop status: the estimated start time until the stop reaches status AT_STOP, after which it is the actual start time reported during execution. ISO 8601 format in UTC."},"children":[]}]}]}],"examples":["2024-12-31T08:00:00Z"]},"incidents":{"anyOf":[{"items":{"$ref":"#/components/schemas/Incident"},"type":"array"},{"type":"null"}],"title":"Incidents","description":"List of incidents"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the stop. One of: TEMPLATE, BLOCKED, TO_PLAN, PLANNED, DISPATCHED, ROUTE_TO_STOP, AT_STOP, COMPLETED, CANCELLED, IGNORED."},"children":[]}]}]}],"examples":["PLANNED"]}},"type":"object","required":["id","location"],"title":"StopOutput"}},"components/schemas/StopOutput-Output":{"id":"components/schemas/StopOutput-Output","kind":"json-schema","title":"StopOutput","data":{"properties":{"activity_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Activity Label","description":"Activity to execute at this location, ie. pickup/collect, couple/uncouple trailer"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"Additional freeform data for this stop"},"reference_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"stop reference number"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number"},"mobile_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mobile Number"},"time_window":{"anyOf":[{"$ref":"#/components/schemas/TimeWindow"},{"type":"null"}],"title":"time_window"},"planning_instructions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Planning Instructions","description":"Additional freeform instructions for the planner."},"extras":{"anyOf":[{"items":{"$ref":"#/components/schemas/StopExtra"},"type":"array"},{"type":"null"}],"title":"Extras","description":"Additional services/options for stop"},"custom_fields":{"type":"object","title":"Custom Fields","description":"Additional user defined fields to fill in"},"date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date","description":"Requested date of the stop, as shown in the planning UI. Empty for stops without a requested date (e.g. standalone stops).","examples":["2024-12-31"]},"depot":{"anyOf":[{"$ref":"#/components/schemas/StopDepotOutput"},{"type":"null"}],"description":"Depot information for the stop. Only relevant for location bookings (load building)."},"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier for stop"},"location":{"$ref":"#/components/schemas/LocationWithTerminalOutput-Output","description":"Location of the stop"},"mileage_km":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Mileage Km","description":"Mileage in kilometers"},"end_timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Timestamp","description":"End of stop. The value depends on the stop status: the estimated end time until the stop reaches status COMPLETED, after which it is the actual end time reported during execution. ISO 8601 format in UTC.","examples":["2024-12-31T08:15:00Z"]},"start_timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Timestamp","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start of stop. The value depends on the stop status: the estimated start time until the stop reaches status AT_STOP, after which it is the actual start time reported during execution. ISO 8601 format in UTC."},"children":[]}]}]}],"examples":["2024-12-31T08:00:00Z"]},"incidents":{"anyOf":[{"items":{"$ref":"#/components/schemas/Incident"},"type":"array"},{"type":"null"}],"title":"Incidents","description":"List of incidents"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the stop. One of: TEMPLATE, BLOCKED, TO_PLAN, PLANNED, DISPATCHED, ROUTE_TO_STOP, AT_STOP, COMPLETED, CANCELLED, IGNORED."},"children":[]}]}]}],"examples":["PLANNED"]}},"type":"object","required":["id","location"],"title":"StopOutput"}},"components/schemas/StopPosition":{"id":"components/schemas/StopPosition","kind":"json-schema","title":"StopPosition","data":{"properties":{"position":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Position"}},"type":"object","title":"StopPosition"}},"components/schemas/StopStatusUpdate":{"id":"components/schemas/StopStatusUpdate","kind":"json-schema","title":"StopStatusUpdate","data":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the stop. If not known, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"match"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property instead."},"children":[]}]}]}]},"match":{"anyOf":[{"$ref":"#/components/schemas/StopMatchTarget"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Matching criteria for the stop to update when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not known. This will attempt to find a match to a single stop using provided filtering criteria. If multiple stops are matched, this update will be discarded"},"children":[]}]}]}]},"eta_start":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Eta Start","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Estimated arrival time (ETA) at the stop in UTC. Include a timezone offset, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+02:00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"eta_end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Eta End","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Estimated departure time (ETD) from the stop in UTC. Include a timezone offset, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+02:00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"status":{"anyOf":[{"$ref":"#/components/schemas/StopStatusUpdateEnum"},{"type":"null"}],"description":"Updated status of the stop."},"question_answers":{"type":"object","title":"Question Answers","description":"Data related to the status update. This data can be mapped to different entities in Qargo."}},"type":"object","title":"StopStatusUpdate","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a stop from an external source."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can update status and data of a stop. Updates on the data happen based on the defined integration_data_mapping"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the integration configuration."},"children":[]}]}]}]}},"components/schemas/StopStatusUpdateEnum":{"id":"components/schemas/StopStatusUpdateEnum","kind":"json-schema","title":"StopStatusUpdateEnum","data":{"type":"string","enum":["AT_STOP","COMPLETED"],"title":"StopStatusUpdateEnum"}},"components/schemas/StopType":{"id":"components/schemas/StopType","kind":"json-schema","title":"StopType","data":{"type":"string","enum":["PICKUP","DELIVERY","DEPOT_LOAD","DEPOT_UNLOAD"],"title":"StopType"}},"components/schemas/StopTypeField":{"id":"components/schemas/StopTypeField","kind":"json-schema","title":"StopTypeField","data":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"row_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Row Id"}},"type":"object","title":"StopTypeField"}},"components/schemas/StopUpdate":{"id":"components/schemas/StopUpdate","kind":"json-schema","title":"StopUpdate","data":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id"},"type":{"type":"string","const":"Stop","title":"Type"},"stop":{"$ref":"#/components/schemas/VisibilityStop"}},"type":"object","required":["id","type","stop"],"title":"StopUpdate","description":"Send update event on stop status change, from order perspective."}},"components/schemas/StopUpdateData":{"id":"components/schemas/StopUpdateData","kind":"json-schema","title":"StopUpdateData","data":{"properties":{"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note"},"date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date"},"reference_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference Number"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number"},"mobile_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mobile Number"},"planning_instructions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Planning Instructions"},"location":{"anyOf":[{"$ref":"#/components/schemas/LocationInput"},{"type":"null"}]},"time_window":{"anyOf":[{"$ref":"#/components/schemas/TimeWindowInput"},{"type":"null"}]},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Custom Fields"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id"}},"type":"object","title":"StopUpdateData"}},"components/schemas/SubcontractorDispatch":{"id":"components/schemas/SubcontractorDispatch","kind":"json-schema","title":"SubcontractorDispatch","data":{"properties":{"operation":{"$ref":"#/components/schemas/DispatchOperation"},"payload":{"$ref":"#/components/schemas/SubcontractorDispatchOutput"}},"type":"object","required":["operation","payload"],"title":"SubcontractorDispatch"}},"components/schemas/SubcontractorDispatchOutput":{"id":"components/schemas/SubcontractorDispatchOutput","kind":"json-schema","title":"SubcontractorDispatchOutput","data":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"ID of the dispatched trip"},"name":{"type":"string","title":"Name"},"orders":{"items":{"$ref":"#/components/schemas/DispatchOrder"},"type":"array","title":"Orders"},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"Custom fields of the dispatched trip"},"resource_allocations":{"anyOf":[{"items":{"$ref":"#/components/schemas/ResourceAllocation-Input"},"type":"array"},{"type":"null"}],"title":"Resource Allocations"},"stops":{"items":{"$ref":"#/components/schemas/StopOutput-Input"},"type":"array","title":"Stops","description":"List of stops, sorted on the sequence in which they have been planned"}},"type":"object","required":["name","orders","resource_allocations","stops"],"title":"SubcontractorDispatchOutput"}},"components/schemas/SubcontractorDispatchResponse":{"id":"components/schemas/SubcontractorDispatchResponse","kind":"json-schema","title":"SubcontractorDispatchResponse","data":{"properties":{"errors":{"anyOf":[{"items":{"$ref":"#/components/schemas/ErrorStatus"},"type":"array"},{"type":"null"}],"title":"Errors","description":"List of errors that occurred during the webhook processing. If empty/omitted, the webhook was processed successfully.","examples":[{"error_message":"The payload is invalid.","error_type":"USER_INPUT_ERROR"},{"error_message":"Not supported.","error_type":"NOT_SUPPORTED"},{"error_message":"Unknown error.","error_type":"INTERNAL_ERROR"}]}},"type":"object","title":"SubcontractorDispatchResponse","description":"Response schema for the subcontractor dispatch payload.\nThis schema is used to return errors or success messages."}},"components/schemas/SubcontractorDocumentWithValidityTypeInput":{"id":"components/schemas/SubcontractorDocumentWithValidityTypeInput","kind":"json-schema","title":"SubcontractorDocumentWithValidityTypeInput","data":{"type":"string","enum":["ATA_CARNET","BANK_DETAILS","CMR_INSURANCE","COMMON_HEALTH_ENTRY_DOCUMENT","COMMUNICATION","COMMUNICATION_SUBCONTRACTOR","SUBCONTRACTOR_CONTRACT","CREDIT_REPORT","DGSA_CERTIFICATE","ECMT_TRANSPORT_LICENSE","EU_TRANSPORT_LICENSE","EXPORT_HEALTH_CERTIFICATE","FINE","FREIGHT_FORWARDER_LICENSE","SUBCONTRACTOR_LICENSE","NATIONAL_TRANSPORT_LICENSE","OTHER","SUBCONTRACTOR_PERMIT","POWER_OF_ATTORNEY","QUESTIONNAIRE_CUSTOMER","QUESTIONNAIRE_SUBCONTRACTOR","SERVICE_LEVEL_AGREEMENT","SQAS_CERTIFICATE","COMPANY_TDS","TRAILER_CLEANING_CERTIFICATE","VAT_VIES_VALIDATION","SUBCONTRACTOR_WASTE_LICENSE","WASTE_PERMIT_GREEN_EU","WASTE_PERMIT_ORANGE_EU","WASTE_PERMIT_ORANGE_GREEN_EU","XL_CERTIFICATE"],"title":"SubcontractorDocumentWithValidityTypeInput"}},"components/schemas/SubcontractorDocumentWithoutValidityTypeInput":{"id":"components/schemas/SubcontractorDocumentWithoutValidityTypeInput","kind":"json-schema","title":"SubcontractorDocumentWithoutValidityTypeInput","data":{"type":"string","enum":["ATA_CARNET","BANK_DETAILS","CARGO_INSURANCE","CMR_INSURANCE","COMMON_HEALTH_ENTRY_DOCUMENT","COMMUNICATION_SUBCONTRACTOR","COMMUNICATION","COMPANY_TDS","CREDIT_REPORT","DGSA_CERTIFICATE","DOMESTIC_CARGO_INSURANCE","ECMT_TRANSPORT_LICENSE","EU_TRANSPORT_LICENSE","EXPORT_HEALTH_CERTIFICATE","FINE","FREIGHT_FORWARDER_LICENSE","INSURANCE_3RD_PARTY_TRAILER","NATIONAL_TRANSPORT_LICENSE","OTHER","POWER_OF_ATTORNEY","QUESTIONNAIRE_CUSTOMER","QUESTIONNAIRE_SUBCONTRACTOR","SERVICE_LEVEL_AGREEMENT","SQAS_CERTIFICATE","SUBCONTRACTOR_CONTRACT","SUBCONTRACTOR_INSURANCE","SUBCONTRACTOR_LIABILITY_INSURANCE","SUBCONTRACTOR_LICENSE","SUBCONTRACTOR_MOTOR_INSURANCE","SUBCONTRACTOR_PERMIT","SUBCONTRACTOR_WASTE_LICENSE","TRAILER_CLEANING_CERTIFICATE","VAT_VIES_VALIDATION","WASTE_PERMIT_GREEN_EU","WASTE_PERMIT_ORANGE_EU","WASTE_PERMIT_ORANGE_GREEN_EU","XL_CERTIFICATE"],"title":"SubcontractorDocumentWithoutValidityTypeInput"}},"components/schemas/SubcontractorInsuranceDocumentTypeInput":{"id":"components/schemas/SubcontractorInsuranceDocumentTypeInput","kind":"json-schema","title":"SubcontractorInsuranceDocumentTypeInput","data":{"type":"string","enum":["DOMESTIC_CARGO_INSURANCE","SUBCONTRACTOR_INSURANCE","INSURANCE_3RD_PARTY_TRAILER","CARGO_INSURANCE","SUBCONTRACTOR_LIABILITY_INSURANCE","SUBCONTRACTOR_MOTOR_INSURANCE"],"title":"SubcontractorInsuranceDocumentTypeInput"}},"components/schemas/SubcontractorMatchInput":{"id":"components/schemas/SubcontractorMatchInput","kind":"json-schema","title":"SubcontractorMatchInput","data":{"properties":{"name":{"anyOf":[{"$ref":"#/components/schemas/FieldMatchInput"},{"type":"null"}]},"generic_id":{"anyOf":[{"$ref":"#/components/schemas/FieldMatchInput"},{"type":"null"}]},"integration_object_id":{"anyOf":[{"$ref":"#/components/schemas/FieldMatchInput"},{"type":"null"}],"description":"The resource ID in the given context of your integration. "}},"type":"object","title":"SubcontractorMatchInput","example":{"name":{"matches_any":["Acme Logistics"]}}}},"components/schemas/SubcontractorStatus":{"id":"components/schemas/SubcontractorStatus","kind":"json-schema","title":"SubcontractorStatus","data":{"type":"string","enum":["NOT_APPROVED","APPROVED","WARNING","BLOCKED"],"title":"SubcontractorStatus"}},"components/schemas/SubcontractorStatusUpdatePayload":{"id":"components/schemas/SubcontractorStatusUpdatePayload","kind":"json-schema","title":"SubcontractorStatusUpdatePayload","data":{"properties":{"updates":{"items":{"$ref":"#/components/schemas/BaseStatusUpdate"},"type":"array","title":"Updates","description":"List of status updates for stops"}},"type":"object","required":["updates"],"title":"SubcontractorStatusUpdatePayload"}},"components/schemas/SubcontractorValidityReason":{"id":"components/schemas/SubcontractorValidityReason","kind":"json-schema","title":"SubcontractorValidityReason","data":{"type":"string","enum":["ATA_CARNET","BANK_DETAILS","CMR_INSURANCE","COMMON_HEALTH_ENTRY_DOCUMENT","COMMUNICATION","COMMUNICATION_SUBCONTRACTOR","SUBCONTRACTOR_CONTRACT","CREDIT_REPORT","DGSA_CERTIFICATE","ECMT_TRANSPORT_LICENSE","EU_TRANSPORT_LICENSE","EXPORT_HEALTH_CERTIFICATE","FINE","FREIGHT_FORWARDER_LICENSE","SUBCONTRACTOR_LICENSE","NATIONAL_TRANSPORT_LICENSE","SUBCONTRACTOR_OTHER","SUBCONTRACTOR_PERMIT","POWER_OF_ATTORNEY","QUESTIONNAIRE_CUSTOMER","QUESTIONNAIRE_SUBCONTRACTOR","SERVICE_LEVEL_AGREEMENT","SQAS_CERTIFICATE","COMPANY_TDS","TRAILER_CLEANING_CERTIFICATE","VAT_VIES_VALIDATION","SUBCONTRACTOR_WASTE_LICENSE","WASTE_PERMIT_GREEN_EU","WASTE_PERMIT_ORANGE_EU","WASTE_PERMIT_ORANGE_GREEN_EU","XL_CERTIFICATE","DOMESTIC_CARGO_INSURANCE","SUBCONTRACTOR_INSURANCE","INSURANCE_3RD_PARTY_TRAILER","CARGO_INSURANCE","SUBCONTRACTOR_LIABILITY_INSURANCE","SUBCONTRACTOR_MOTOR_INSURANCE"],"title":"SubcontractorValidityReason"}},"components/schemas/SubjectType":{"id":"components/schemas/SubjectType","kind":"json-schema","title":"SubjectType","data":{"type":"string","enum":["SALES_INVOICE","SALES_CREDIT_NOTE","PURCHASE_INVOICE","PURCHASE_CREDIT_NOTE"],"title":"SubjectType"}},"components/schemas/TPNConsignmentInput":{"id":"components/schemas/TPNConsignmentInput","kind":"json-schema","title":"TPNConsignmentInput","data":{"properties":{"consignment_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Consignment Number"}},"type":"object","title":"TPNConsignmentInput"}},"components/schemas/TachographActivityEnum":{"id":"components/schemas/TachographActivityEnum","kind":"json-schema","title":"TachographActivityEnum","data":{"type":"string","enum":["DRIVING","WORKING","BREAK","REST","WAITING","UNKNOWN"],"title":"TachographActivityEnum"}},"components/schemas/TaskDetail":{"id":"components/schemas/TaskDetail","kind":"json-schema","title":"TaskDetail","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"status":{"$ref":"#/components/schemas/TaskStatus"},"task_type":{"$ref":"#/components/schemas/TaskType"},"execution_metadata":{"anyOf":[{"$ref":"#/components/schemas/TaskInstanceExecutionMetadata"},{"type":"null"}]},"payload":{"anyOf":[{"$ref":"#/components/schemas/TaskPayload"},{"type":"null"}]},"invoice_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Invoice Id"}},"type":"object","required":["id","status","task_type"],"title":"TaskDetail"}},"components/schemas/TaskFailureStatus":{"id":"components/schemas/TaskFailureStatus","kind":"json-schema","title":"TaskFailureStatus","data":{"properties":{"error_type":{"$ref":"#/components/schemas/ErrorType"},"error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Message","description":"(User visible) error message"}},"type":"object","required":["error_type"],"title":"TaskFailureStatus"}},"components/schemas/TaskInstanceExecutionMetadata":{"id":"components/schemas/TaskInstanceExecutionMetadata","kind":"json-schema","title":"TaskInstanceExecutionMetadata","data":{"properties":{"external_execution":{"anyOf":[{"$ref":"#/components/schemas/ExternalExecutionMetadata"},{"type":"null"}]}},"type":"object","title":"TaskInstanceExecutionMetadata"}},"components/schemas/TaskPayload":{"id":"components/schemas/TaskPayload","kind":"json-schema","title":"TaskPayload","data":{"properties":{"subject_id":{"type":"string","format":"uuid","title":"Subject Id","description":"Task target id"},"subject_type":{"$ref":"#/components/schemas/SubjectType","description":"Task target type"},"documents":{"items":{"$ref":"#/components/schemas/Document"},"type":"array","title":"Documents","description":"List of related documents"},"instance":{"anyOf":[{"$ref":"#/components/schemas/SalesInvoiceOutput"},{"$ref":"#/components/schemas/PurchaseInvoice"},{"$ref":"#/components/schemas/SalesCreditNoteOutput"},{"$ref":"#/components/schemas/PurchaseCreditNote"}],"title":"Instance"}},"type":"object","required":["subject_id","subject_type","instance"],"title":"TaskPayload","description":"Task execution input data."}},"components/schemas/TaskStatus":{"id":"components/schemas/TaskStatus","kind":"json-schema","title":"TaskStatus","data":{"type":"string","enum":["TODO","COMPLETED","FAILED","WAITING"],"title":"TaskStatus"}},"components/schemas/TaskStatusInput":{"id":"components/schemas/TaskStatusInput","kind":"json-schema","title":"TaskStatusInput","data":{"type":"string","enum":["COMPLETED","FAILED"],"title":"TaskStatusInput"}},"components/schemas/TaskType":{"id":"components/schemas/TaskType","kind":"json-schema","title":"TaskType","data":{"type":"string","enum":["POST_INVOICE","POST_INVOICE_PURCHASE","POST_CREDIT_NOTE","POST_CREDIT_NOTE_PURCHASE","PAID_INVOICE","PAID_INVOICE_PURCHASE","REFUNDED_CREDIT_NOTE","REFUNDED_CREDIT_NOTE_PURCHASE","DISPATCH"],"title":"TaskType"}},"components/schemas/TaskUpdate":{"id":"components/schemas/TaskUpdate","kind":"json-schema","title":"TaskUpdate","data":{"properties":{"status":{"$ref":"#/components/schemas/TaskStatus"}},"type":"object","required":["status"],"title":"TaskUpdate","description":"Update task status result."}},"components/schemas/TaskUpdateInput":{"id":"components/schemas/TaskUpdateInput","kind":"json-schema","title":"TaskUpdateInput","data":{"properties":{"status":{"$ref":"#/components/schemas/TaskStatusInput"},"failure":{"anyOf":[{"$ref":"#/components/schemas/TaskFailureStatus"},{"type":"null"}]}},"type":"object","required":["status"],"title":"TaskUpdateInput","description":"Update task status on completion/failure.\n\nThe failure field can be used to provide more information on failure."}},"components/schemas/TaxRateInput":{"id":"components/schemas/TaxRateInput","kind":"json-schema","title":"TaxRateInput","data":{"properties":{"name":{"type":"string","title":"Name","description":"Display name of the tax rate."},"percentage":{"type":"number","title":"Percentage","description":"Tax percentage, e.g. 21.0."},"base_percentage":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Base Percentage","description":"Base percentage before tax rule adjustments."},"code":{"type":"string","title":"Code","description":"Code used in the external accounting software."},"tax_type":{"$ref":"#/components/schemas/TaxRateType","description":"Tax type classification."},"invoice_type":{"$ref":"#/components/schemas/TaxRateInvoiceType","description":"Invoice type this tax rate applies to."},"description":{"type":"string","title":"Description","description":"Optional description of the tax rate.","default":""},"billing_entity":{"$ref":"#/components/schemas/BillingEntityReference","description":"Billing entity this tax rate belongs to, referenced by code."},"archived":{"type":"boolean","title":"Archived","description":"Whether this tax rate is archived.","default":false}},"type":"object","required":["name","percentage","code","tax_type","invoice_type","billing_entity"],"title":"TaxRateInput"}},"components/schemas/TaxRateInvoiceType":{"id":"components/schemas/TaxRateInvoiceType","kind":"json-schema","title":"TaxRateInvoiceType","data":{"type":"string","enum":["SALES","SALES_CREDIT_NOTE","PURCHASE","PURCHASE_CREDIT_NOTE"],"title":"TaxRateInvoiceType"}},"components/schemas/TaxRateOutput":{"id":"components/schemas/TaxRateOutput","kind":"json-schema","title":"TaxRateOutput","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier of the record in Qargo."},"archived":{"type":"boolean","title":"Archived","description":"Whether this record has been archived."},"name":{"type":"string","title":"Name","description":"Display name of the tax rate."},"billing_entity":{"$ref":"#/components/schemas/BillingEntity","description":"Billing entity this tax rate belongs to."},"percentage":{"type":"number","title":"Percentage","description":"Tax percentage, e.g. 21.0."},"base_percentage":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Base Percentage","description":"Base percentage before applying customer/transport-specific tax rules."},"code":{"type":"string","title":"Code","description":"Code used in the external accounting software."},"tax_type":{"$ref":"#/components/schemas/TaxRateType","description":"Tax type classification."},"invoice_type":{"$ref":"#/components/schemas/TaxRateInvoiceType","description":"Invoice type this tax rate applies to."},"description":{"type":"string","title":"Description","description":"Optional description of the tax rate."}},"type":"object","required":["id","archived","name","billing_entity","percentage","code","tax_type","invoice_type","description"],"title":"TaxRateOutput"}},"components/schemas/TaxRatePartialInput":{"id":"components/schemas/TaxRatePartialInput","kind":"json-schema","title":"TaxRatePartialInput","data":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Display name of the tax rate."},"percentage":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Percentage","description":"Tax percentage, e.g. 21.0."},"base_percentage":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Base Percentage","description":"Base percentage before tax rule adjustments."},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code used in the external accounting software."},"tax_type":{"anyOf":[{"$ref":"#/components/schemas/TaxRateType"},{"type":"null"}],"description":"Tax type classification."},"invoice_type":{"anyOf":[{"$ref":"#/components/schemas/TaxRateInvoiceType"},{"type":"null"}],"description":"Invoice type this tax rate applies to."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Optional description of the tax rate."},"billing_entity":{"anyOf":[{"$ref":"#/components/schemas/BillingEntityReference"},{"type":"null"}],"description":"Billing entity this tax rate belongs to, referenced by code."},"archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Archived","description":"Whether this tax rate is archived."}},"type":"object","title":"TaxRatePartialInput"}},"components/schemas/TaxRateReference":{"id":"components/schemas/TaxRateReference","kind":"json-schema","title":"TaxRateReference","data":{"properties":{"code":{"type":"string","title":"Code","description":"Code of the reference"}},"type":"object","required":["code"],"title":"TaxRateReference"}},"components/schemas/TaxRateType":{"id":"components/schemas/TaxRateType","kind":"json-schema","title":"TaxRateType","data":{"type":"string","enum":["VAT","NO_VAT","REVERSE_CHARGE","TRANSIT","CO_CONTRACTING","OTHER"],"title":"TaxRateType"}},"components/schemas/TaxTypeEnum":{"id":"components/schemas/TaxTypeEnum","kind":"json-schema","title":"TaxTypeEnum","data":{"type":"string","enum":["VAT","REVERSE_CHARGE","TRANSIT","NO_VAT","CO_CONTRACTING","OTHER"],"title":"TaxTypeEnum"}},"components/schemas/TemperatureRequirements":{"id":"components/schemas/TemperatureRequirements","kind":"json-schema","title":"TemperatureRequirements","data":{"properties":{"desired_temperature":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Desired Temperature","description":"Desired temperature set point."},"desired_dual_temperature":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Desired Dual Temperature","description":"Desired temperature set point for the second compartment, for dual-zone units."}},"type":"object","title":"TemperatureRequirements"}},"components/schemas/TerminalMetadata":{"id":"components/schemas/TerminalMetadata","kind":"json-schema","title":"TerminalMetadata","data":{"properties":{"terminal_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Terminal Email"},"sgkv_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sgkv Code"},"uirr_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Uirr Code"},"unlo_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unlo Code"},"gateway":{"anyOf":[{"$ref":"#/components/schemas/Gateway"},{"type":"null"}]}},"type":"object","title":"TerminalMetadata"}},"components/schemas/TimeInterval":{"id":"components/schemas/TimeInterval","kind":"json-schema","title":"TimeInterval","data":{"properties":{"start_time":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start Time","description":"Opening time of the interval, formatted as HH:MM.","examples":["08:00"]},"end_time":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End Time","description":"Closing time of the interval, formatted as HH:MM.","examples":["17:30"]}},"type":"object","title":"TimeInterval"}},"components/schemas/TimeIntervalInput":{"id":"components/schemas/TimeIntervalInput","kind":"json-schema","title":"TimeIntervalInput","data":{"properties":{"start_time":{"type":"string","format":"time","title":"Start Time","description":"Opening time of the interval, formatted as HH:MM.","examples":["08:00"]},"end_time":{"type":"string","format":"time","title":"End Time","description":"Closing time of the interval, formatted as HH:MM.","examples":["17:30"]}},"type":"object","required":["start_time","end_time"],"title":"TimeIntervalInput"}},"components/schemas/TimeWindow":{"id":"components/schemas/TimeWindow","kind":"json-schema","title":"TimeWindow","data":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Human readable identifier"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Machine readable identifier"},"start_time":{"anyOf":[{"type":"string","format":"time"},{"type":"null"}],"title":"Start Time","description":"Start of time window","examples":["09:30"]},"end_time":{"anyOf":[{"type":"string","format":"time"},{"type":"null"}],"title":"End Time","description":"End of time window","examples":["16:30"]},"custom_fields":{"type":"object","title":"Custom Fields","description":"Store values for user defined fields"},"is_enforced":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Enforced","description":"Enforce the time window for this stop"},"use_location_opening_hours":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Use Location Opening Hours","description":"When true, the stop's time window is derived from the location's opening hours instead of explicit start/end times"}},"type":"object","title":"TimeWindow"}},"components/schemas/TimeWindowInput":{"id":"components/schemas/TimeWindowInput","kind":"json-schema","title":"TimeWindowInput","data":{"properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"start_time":{"anyOf":[{"type":"string","format":"time"},{"type":"null"}],"title":"Start Time"},"end_time":{"anyOf":[{"type":"string","format":"time"},{"type":"null"}],"title":"End Time"},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Custom Fields"},"is_enforced":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Enforced"}},"type":"object","title":"TimeWindowInput"}},"components/schemas/Token":{"id":"components/schemas/Token","kind":"json-schema","title":"Token","data":{"properties":{"access_token":{"type":"string","title":"Access Token"},"token_type":{"type":"string","title":"Token Type"},"expires_in":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Expires In"}},"type":"object","required":["access_token","token_type","expires_in"],"title":"Token"}},"components/schemas/TrackingMatchInput":{"id":"components/schemas/TrackingMatchInput","kind":"json-schema","title":"TrackingMatchInput","data":{"properties":{"resource":{"anyOf":[{"$ref":"#/components/schemas/TrackingResourceMatchInput"},{"type":"null"}]}},"type":"object","title":"TrackingMatchInput"}},"components/schemas/TrackingMatchTarget":{"id":"components/schemas/TrackingMatchTarget","kind":"json-schema","title":"TrackingMatchTarget","data":{"properties":{"matches_any":{"items":{"$ref":"#/components/schemas/TrackingMatchInput"},"type":"array","title":"Matches Any"}},"type":"object","title":"TrackingMatchTarget"}},"components/schemas/TrackingResourceMatchInput":{"id":"components/schemas/TrackingResourceMatchInput","kind":"json-schema","title":"TrackingResourceMatchInput","data":{"properties":{"driver":{"anyOf":[{"$ref":"#/components/schemas/DriverMatchInput"},{"type":"null"}]},"vehicle":{"anyOf":[{"$ref":"#/components/schemas/VehicleMatchInput"},{"type":"null"}]},"subcontractor":{"anyOf":[{"$ref":"#/components/schemas/SubcontractorMatchInput"},{"type":"null"}]},"container":{"anyOf":[{"$ref":"#/components/schemas/ContainerMatchInput"},{"type":"null"}]}},"type":"object","title":"TrackingResourceMatchInput"}},"components/schemas/TrackingUpdateData":{"id":"components/schemas/TrackingUpdateData","kind":"json-schema","title":"TrackingUpdateData","data":{"properties":{"position":{"anyOf":[{"$ref":"#/components/schemas/TrackingUpdatePositionData"},{"type":"null"}]},"temperature":{"anyOf":[{"$ref":"#/components/schemas/TrackingUpdateTemperatureData"},{"type":"null"}]},"tachograph":{"anyOf":[{"$ref":"#/components/schemas/TrackingUpdateTachographData"},{"type":"null"}]},"fuel":{"anyOf":[{"$ref":"#/components/schemas/TrackingUpdateFuelData"},{"type":"null"}]},"mileage":{"anyOf":[{"$ref":"#/components/schemas/TrackingUpdateMileageData"},{"type":"null"}]},"weight":{"anyOf":[{"$ref":"#/components/schemas/TrackingUpdateWeightData"},{"type":"null"}]},"voltage":{"anyOf":[{"$ref":"#/components/schemas/TrackingUpdateVoltageData"},{"type":"null"}]}},"type":"object","title":"TrackingUpdateData"}},"components/schemas/TrackingUpdateFuelData":{"id":"components/schemas/TrackingUpdateFuelData","kind":"json-schema","title":"TrackingUpdateFuelData","data":{"properties":{"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"Timestamp at which tracking event occured","examples":["2024-01-15T10:30:00Z"]},"fuel_level_percentage":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Fuel Level Percentage","examples":[75]}},"type":"object","required":["timestamp"],"title":"TrackingUpdateFuelData"}},"components/schemas/TrackingUpdateItem":{"id":"components/schemas/TrackingUpdateItem","kind":"json-schema","title":"TrackingUpdateItem","data":{"properties":{"tracking_match":{"$ref":"#/components/schemas/TrackingMatchTarget"},"tracking_update_data":{"items":{"$ref":"#/components/schemas/TrackingUpdateData"},"type":"array","title":"Tracking Update Data"}},"type":"object","required":["tracking_match"],"title":"TrackingUpdateItem"}},"components/schemas/TrackingUpdateMileageData":{"id":"components/schemas/TrackingUpdateMileageData","kind":"json-schema","title":"TrackingUpdateMileageData","data":{"properties":{"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"Timestamp at which tracking event occured","examples":["2024-01-15T10:30:00Z"]},"mileage_meter":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Mileage Meter","examples":[150000]}},"type":"object","required":["timestamp"],"title":"TrackingUpdateMileageData"}},"components/schemas/TrackingUpdatePayload":{"id":"components/schemas/TrackingUpdatePayload","kind":"json-schema","title":"TrackingUpdatePayload","data":{"properties":{"updates":{"items":{"$ref":"#/components/schemas/TrackingUpdateItem"},"type":"array","title":"Updates","description":"List of tracking updates to process"}},"type":"object","title":"TrackingUpdatePayload"}},"components/schemas/TrackingUpdatePositionData":{"id":"components/schemas/TrackingUpdatePositionData","kind":"json-schema","title":"TrackingUpdatePositionData","data":{"properties":{"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"Timestamp at which tracking event occured","examples":["2024-01-15T10:30:00Z"]},"latitude":{"type":"number","title":"Latitude","examples":[51.0543]},"longitude":{"type":"number","title":"Longitude","examples":[3.7174]}},"type":"object","required":["timestamp","latitude","longitude"],"title":"TrackingUpdatePositionData"}},"components/schemas/TrackingUpdateResponse":{"id":"components/schemas/TrackingUpdateResponse","kind":"json-schema","title":"TrackingUpdateResponse","data":{"properties":{"errors":{"anyOf":[{"items":{"$ref":"#/components/schemas/ErrorStatus"},"type":"array"},{"type":"null"}],"title":"Errors","description":"List of errors that occurred during the webhook processing. If empty/omitted, the webhook was processed successfully.","examples":[{"error_message":"The payload is invalid.","error_type":"USER_INPUT_ERROR"},{"error_message":"Not supported.","error_type":"NOT_SUPPORTED"},{"error_message":"Unknown error.","error_type":"INTERNAL_ERROR"}]}},"type":"object","title":"TrackingUpdateResponse","description":"Response schema for the tracking update webhook.\nThis schema is used to return errors or success messages."}},"components/schemas/TrackingUpdateTachographData":{"id":"components/schemas/TrackingUpdateTachographData","kind":"json-schema","title":"TrackingUpdateTachographData","data":{"properties":{"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"Timestamp at which tracking event occured","examples":["2024-01-15T10:30:00Z"]},"activity":{"anyOf":[{"$ref":"#/components/schemas/TachographActivityEnum"},{"type":"null"}],"description":"Tachograph activity","examples":["DRIVING"]},"driving_since":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Driving Since","examples":["2024-01-15T08:00:00Z"]},"resting_since":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Resting Since"},"on_break_since":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"On Break Since"},"waiting_since":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Waiting Since"},"next_break_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Next Break At","examples":["2024-01-15T12:30:00Z"]},"next_rest_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Next Rest At"}},"type":"object","required":["timestamp"],"title":"TrackingUpdateTachographData"}},"components/schemas/TrackingUpdateTemperatureData":{"id":"components/schemas/TrackingUpdateTemperatureData","kind":"json-schema","title":"TrackingUpdateTemperatureData","data":{"properties":{"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"Timestamp at which tracking event occured","examples":["2024-01-15T10:30:00Z"]},"temperatures":{"items":{"$ref":"#/components/schemas/TrackingUpdateTemperatureMeasurement"},"type":"array","title":"Temperatures"},"temperature_setpoints":{"items":{"$ref":"#/components/schemas/TrackingUpdateTemperatureMeasurement"},"type":"array","title":"Temperature Setpoints"}},"type":"object","required":["timestamp"],"title":"TrackingUpdateTemperatureData"}},"components/schemas/TrackingUpdateTemperatureMeasurement":{"id":"components/schemas/TrackingUpdateTemperatureMeasurement","kind":"json-schema","title":"TrackingUpdateTemperatureMeasurement","data":{"properties":{"sensor":{"type":"string","title":"Sensor","description":"The sensor from which the temperature was measured","examples":["sensor-1"]},"temperature":{"type":"number","title":"Temperature","description":"The measured temperature value in degrees Celsius","examples":[-18.5]}},"type":"object","required":["sensor","temperature"],"title":"TrackingUpdateTemperatureMeasurement"}},"components/schemas/TrackingUpdateVoltageData":{"id":"components/schemas/TrackingUpdateVoltageData","kind":"json-schema","title":"TrackingUpdateVoltageData","data":{"properties":{"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"Timestamp at which tracking event occured","examples":["2024-01-15T10:30:00Z"]},"external_power_supply_voltage_mv":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"External Power Supply Voltage Mv","description":"External supply voltage in millivolts. Report the voltage of the external power line, not the internal battery: a unit running on its own battery should report a value at or near zero.","examples":[24000]}},"type":"object","required":["timestamp"],"title":"TrackingUpdateVoltageData"}},"components/schemas/TrackingUpdateWeightData":{"id":"components/schemas/TrackingUpdateWeightData","kind":"json-schema","title":"TrackingUpdateWeightData","data":{"properties":{"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"Timestamp at which tracking event occured","examples":["2024-01-15T10:30:00Z"]},"axle_weight":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Axle Weight","examples":[8500]}},"type":"object","required":["timestamp"],"title":"TrackingUpdateWeightData"}},"components/schemas/TractorProperties-Input":{"id":"components/schemas/TractorProperties-Input","kind":"json-schema","title":"TractorProperties","data":{"properties":{"tare_weight_kg":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Tare Weight Kg","description":"Tare weight of the tractor in kg","examples":[10000]},"exterior_length_m":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Exterior Length M","description":"Exterior length of the tractor in meter","examples":[10]},"exterior_width_m":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Exterior Width M","description":"Exterior width of the tractor in meter","examples":[5]},"exterior_height_m":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Exterior Height M","description":"Exterior height of the tractor in meter","examples":[3]},"vin_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vin Number","description":"VIN number of the tractor"},"manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Manufacturer","description":"Manufacturer of the tractor"},"license_plate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"License Plate","description":"License plate of the tractor"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"Model of the tractor"},"axle_configuration":{"anyOf":[{"type":"string","enum":["AC_4_X_2","AC_4_X_4","AC_6_X_2","AC_6_X_4","AC_6_X_6","AC_8_X_2","AC_8_X_4","AC_8_X_6","AC_10_X_4","AC_12_X_4"]},{"type":"null"}],"title":"Axle Configuration","description":"Axle configuration of the tractor"},"emission_class":{"anyOf":[{"type":"string","enum":["EURO_1","EURO_2","EURO_3","EURO_4","EURO_5","EURO_6"]},{"type":"null"}],"title":"Emission Class","description":"Emission class of the tractor"},"fuel_type":{"anyOf":[{"type":"string","enum":["DIESEL","BIOFUELS","LPG","ELECTRIC","HYBRID_ELECTRIC"]},{"type":"null"}],"title":"Fuel Type","description":"Fuel type of the tractor"}},"type":"object","title":"TractorProperties"}},"components/schemas/TractorProperties-Output":{"id":"components/schemas/TractorProperties-Output","kind":"json-schema","title":"TractorProperties","data":{"properties":{"tare_weight_kg":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tare Weight Kg","description":"Tare weight of the tractor in kg","examples":[10000]},"exterior_length_m":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Exterior Length M","description":"Exterior length of the tractor in meter","examples":[10]},"exterior_width_m":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Exterior Width M","description":"Exterior width of the tractor in meter","examples":[5]},"exterior_height_m":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Exterior Height M","description":"Exterior height of the tractor in meter","examples":[3]},"vin_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vin Number","description":"VIN number of the tractor"},"manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Manufacturer","description":"Manufacturer of the tractor"},"license_plate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"License Plate","description":"License plate of the tractor"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"Model of the tractor"},"axle_configuration":{"anyOf":[{"type":"string","enum":["AC_4_X_2","AC_4_X_4","AC_6_X_2","AC_6_X_4","AC_6_X_6","AC_8_X_2","AC_8_X_4","AC_8_X_6","AC_10_X_4","AC_12_X_4"]},{"type":"null"}],"title":"Axle Configuration","description":"Axle configuration of the tractor"},"emission_class":{"anyOf":[{"type":"string","enum":["EURO_1","EURO_2","EURO_3","EURO_4","EURO_5","EURO_6"]},{"type":"null"}],"title":"Emission Class","description":"Emission class of the tractor"},"fuel_type":{"anyOf":[{"type":"string","enum":["DIESEL","BIOFUELS","LPG","ELECTRIC","HYBRID_ELECTRIC"]},{"type":"null"}],"title":"Fuel Type","description":"Fuel type of the tractor"}},"type":"object","title":"TractorProperties"}},"components/schemas/TractorResourceInput":{"id":"components/schemas/TractorResourceInput","kind":"json-schema","title":"TractorResourceInput","data":{"properties":{"is_archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Archived","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reactivate a previously archived resource, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to archive it. Only takes effect when included in the request; omit it to leave the archive state unchanged."},"children":[]}]}]}]},"billing_entity":{"anyOf":[{"$ref":"#/components/schemas/BillingEntityReference"},{"type":"null"}],"description":"Billing entity associated with the resource, defaults to default billing entity if not provided"},"extras":{"anyOf":[{"items":{"$ref":"#/components/schemas/ResourceExtraInput"},"type":"array"},{"type":"null"}],"title":"Extras","description":"Stop extras this resource is compatible with. Replaces the existing list when provided. Send an empty list to clear all compatible extras."},"name":{"type":"string","title":"Name","description":"Name of the resource"},"external_id":{"type":"string","title":"External Id","description":"External identifier of the resource","default":""},"locale":{"anyOf":[{"type":"string","pattern":"^[a-z]{2}(-[A-Z]{2})?$"},{"type":"null"}],"title":"Locale","description":"Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.","examples":["en","nl","en-GB","fr-BE"]},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code of the resource"},"note":{"type":"string","title":"Note","description":"Note about the resource","default":""},"custom_fields":{"type":"object","title":"Custom Fields","description":"User defined additional fields for this resource"},"subcontractor":{"anyOf":[{"$ref":"#/components/schemas/CompanyReference"},{"type":"null"}],"description":"Company linked to the resource"},"integrations":{"anyOf":[{"additionalProperties":{"type":"object"},"type":"object"},{"type":"null"}],"title":"Integrations","description":"Related integrations for the resource. The key is the unique code of the integration in Qargo","examples":[{"addsecure1234":{"active":true,"object_id":"1234"}}]},"tractor":{"anyOf":[{"$ref":"#/components/schemas/TractorProperties-Input"},{"type":"null"}],"description":"Tractor specific properties"}},"type":"object","required":["name"],"title":"TractorResourceInput"}},"components/schemas/TractorResourceOutput":{"id":"components/schemas/TractorResourceOutput","kind":"json-schema","title":"TractorResourceOutput","data":{"properties":{"row_id":{"type":"string","format":"uuid","title":"Row Id","description":"Identifier of the reference"},"name":{"type":"string","title":"Name","description":"Name of the resource"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":"External identifier of the resource"},"locale":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Locale","description":"Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.","examples":["en","nl","en-GB","fr-BE"]},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code of the resource"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"Note about the resource"},"custom_fields":{"type":"object","title":"Custom Fields","description":"User defined additional fields for this resource"},"subcontractor":{"anyOf":[{"$ref":"#/components/schemas/CompanyReference"},{"type":"null"}],"description":"Company linked to the resource"},"integrations":{"anyOf":[{"additionalProperties":{"type":"object"},"type":"object"},{"type":"null"}],"title":"Integrations","description":"Related integrations for the resource. The key is the unique code of the integration in Qargo","examples":[{"addsecure1234":{"active":true,"object_id":"1234"}}]},"billing_entity":{"anyOf":[{"$ref":"#/components/schemas/BillingEntity"},{"type":"null"}],"description":"Billing entity associated with the resource"},"extras":{"items":{"$ref":"#/components/schemas/ResourceExtraOutput"},"type":"array","title":"Extras","description":"Stop extras this resource is compatible with"},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Active","description":"Is the resource active"},"is_external_resource":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is External Resource","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Read-only. True if this is a non-owned (subcontractor) resource. When this resource appears inside a trip, name / license_plate / container_number reflect the per-trip override value if one was set on the resource allocation; otherwise the resource master value is returned. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the value is not yet projected — treat as internal for backwards compatibility."},"children":[]}]}]}],"examples":[true]},"timestamp_updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp Updated","description":"Timestamp of the last update of the resource"},"resource_groups":{"items":{"$ref":"#/components/schemas/ResourceGroupOutput"},"type":"array","title":"Resource Groups","description":"Resource groups this resource currently belongs to (deduplicated and sorted by name). A resource can belong to more than one group. Active allocations are included regardless of their validity window (scheduled, future, or expired); archived allocations are excluded."},"tractor":{"anyOf":[{"$ref":"#/components/schemas/TractorProperties-Output"},{"type":"null"}],"description":"Tractor specific properties"}},"type":"object","required":["row_id","name"],"title":"TractorResourceOutput"}},"components/schemas/Trailer":{"id":"components/schemas/Trailer","kind":"json-schema","title":"Trailer","data":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"ID of the resource"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the resource"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code of the resource"},"is_archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Archived","description":"Is the resource archived"},"is_external_resource":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is External Resource","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Read-only. True if this is a non-owned (subcontractor) resource. When this resource appears inside a trip, name / license_plate / container_number reflect the per-trip override value if one was set on the resource allocation; otherwise the resource master value is returned. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the value is not yet projected — treat as internal for backwards compatibility."},"children":[]}]}]}],"examples":[true]},"custom_fields":{"type":"object","title":"Custom Fields","description":"Store values for user defined fields"},"subcontractor":{"anyOf":[{"$ref":"#/components/schemas/CompanyOutput-Input"},{"type":"null"}],"description":"Subcontractor linked to the resource"},"resource_type":{"anyOf":[{"$ref":"#/components/schemas/ResourceTypeEnum"},{"type":"null"}],"description":"Type of the resource"},"axle_configuration":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Axle Configuration","description":"Axle configuration of the vehicle"},"emission_class":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Emission Class","description":"Emission class of the vehicle"},"fuel_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fuel Type","description":"Fuel type of the vehicle"},"license_plate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"License Plate","description":"License plate of the vehicle"},"manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Manufacturer","description":"Manufacturer of the vehicle"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"Model of the vehicle"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"Note about the vehicle"},"roof_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Roof Type","description":"Roof type of the vehicle"},"vin_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vin Number","description":"VIN number of the vehicle"}},"type":"object","title":"Trailer"}},"components/schemas/TrailerProperties-Input":{"id":"components/schemas/TrailerProperties-Input","kind":"json-schema","title":"TrailerProperties","data":{"properties":{"capacity_pallet_spaces":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Capacity Pallet Spaces","description":"Capacity of the trailer in pallet spaces","examples":[10]},"capacity_volume_m3":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Capacity Volume M3","description":"Capacity of the trailer in cubic meters","examples":[10]},"capacity_weight_kg":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Capacity Weight Kg","description":"Capacity of the trailer in kg","examples":[10000]},"tare_weight_kg":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Tare Weight Kg","description":"Tare weight of the trailer in kg","examples":[10000]},"exterior_length_m":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Exterior Length M","description":"Exterior length of the trailer in meter","examples":[10]},"exterior_width_m":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Exterior Width M","description":"Exterior width of the trailer in meter","examples":[5]},"exterior_height_m":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Exterior Height M","description":"Exterior height of the trailer in meter","examples":[3]},"gross_weight_vehicle_rating_weight_kg":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Gross Weight Vehicle Rating Weight Kg","description":"Gross weight vehicle rating weight of the trailer in kg","examples":[10]},"license_plate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"License Plate","description":"License plate of the trailer"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"Model of the trailer"},"manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Manufacturer","description":"Manufacturer of the trailer"},"vin_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vin Number","description":"VIN number of the trailer"},"axle_configuration":{"anyOf":[{"type":"string","enum":["AC_12_TRAILER","AC_10_TRAILER","AC_8_TRAILER","AC_6_TRAILER","AC_4_TRAILER","AC_2_TRAILER"]},{"type":"null"}],"title":"Axle Configuration","description":"Axle configuration of the trailer"}},"type":"object","title":"TrailerProperties"}},"components/schemas/TrailerProperties-Output":{"id":"components/schemas/TrailerProperties-Output","kind":"json-schema","title":"TrailerProperties","data":{"properties":{"capacity_pallet_spaces":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Capacity Pallet Spaces","description":"Capacity of the trailer in pallet spaces","examples":[10]},"capacity_volume_m3":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Capacity Volume M3","description":"Capacity of the trailer in cubic meters","examples":[10]},"capacity_weight_kg":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Capacity Weight Kg","description":"Capacity of the trailer in kg","examples":[10000]},"tare_weight_kg":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tare Weight Kg","description":"Tare weight of the trailer in kg","examples":[10000]},"exterior_length_m":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Exterior Length M","description":"Exterior length of the trailer in meter","examples":[10]},"exterior_width_m":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Exterior Width M","description":"Exterior width of the trailer in meter","examples":[5]},"exterior_height_m":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Exterior Height M","description":"Exterior height of the trailer in meter","examples":[3]},"gross_weight_vehicle_rating_weight_kg":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Gross Weight Vehicle Rating Weight Kg","description":"Gross weight vehicle rating weight of the trailer in kg","examples":[10]},"license_plate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"License Plate","description":"License plate of the trailer"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"Model of the trailer"},"manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Manufacturer","description":"Manufacturer of the trailer"},"vin_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vin Number","description":"VIN number of the trailer"},"axle_configuration":{"anyOf":[{"type":"string","enum":["AC_12_TRAILER","AC_10_TRAILER","AC_8_TRAILER","AC_6_TRAILER","AC_4_TRAILER","AC_2_TRAILER"]},{"type":"null"}],"title":"Axle Configuration","description":"Axle configuration of the trailer"}},"type":"object","title":"TrailerProperties"}},"components/schemas/TrailerResourceInput":{"id":"components/schemas/TrailerResourceInput","kind":"json-schema","title":"TrailerResourceInput","data":{"properties":{"is_archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Archived","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reactivate a previously archived resource, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to archive it. Only takes effect when included in the request; omit it to leave the archive state unchanged."},"children":[]}]}]}]},"billing_entity":{"anyOf":[{"$ref":"#/components/schemas/BillingEntityReference"},{"type":"null"}],"description":"Billing entity associated with the resource, defaults to default billing entity if not provided"},"extras":{"anyOf":[{"items":{"$ref":"#/components/schemas/ResourceExtraInput"},"type":"array"},{"type":"null"}],"title":"Extras","description":"Stop extras this resource is compatible with. Replaces the existing list when provided. Send an empty list to clear all compatible extras."},"name":{"type":"string","title":"Name","description":"Name of the resource"},"external_id":{"type":"string","title":"External Id","description":"External identifier of the resource","default":""},"locale":{"anyOf":[{"type":"string","pattern":"^[a-z]{2}(-[A-Z]{2})?$"},{"type":"null"}],"title":"Locale","description":"Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.","examples":["en","nl","en-GB","fr-BE"]},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code of the resource"},"note":{"type":"string","title":"Note","description":"Note about the resource","default":""},"custom_fields":{"type":"object","title":"Custom Fields","description":"User defined additional fields for this resource"},"subcontractor":{"anyOf":[{"$ref":"#/components/schemas/CompanyReference"},{"type":"null"}],"description":"Company linked to the resource"},"integrations":{"anyOf":[{"additionalProperties":{"type":"object"},"type":"object"},{"type":"null"}],"title":"Integrations","description":"Related integrations for the resource. The key is the unique code of the integration in Qargo","examples":[{"addsecure1234":{"active":true,"object_id":"1234"}}]},"trailer":{"anyOf":[{"$ref":"#/components/schemas/TrailerProperties-Input"},{"type":"null"}],"description":"Trailer specific properties"}},"type":"object","required":["name"],"title":"TrailerResourceInput"}},"components/schemas/TrailerResourceOutput":{"id":"components/schemas/TrailerResourceOutput","kind":"json-schema","title":"TrailerResourceOutput","data":{"properties":{"row_id":{"type":"string","format":"uuid","title":"Row Id","description":"Identifier of the reference"},"name":{"type":"string","title":"Name","description":"Name of the resource"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":"External identifier of the resource"},"locale":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Locale","description":"Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.","examples":["en","nl","en-GB","fr-BE"]},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code of the resource"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"Note about the resource"},"custom_fields":{"type":"object","title":"Custom Fields","description":"User defined additional fields for this resource"},"subcontractor":{"anyOf":[{"$ref":"#/components/schemas/CompanyReference"},{"type":"null"}],"description":"Company linked to the resource"},"integrations":{"anyOf":[{"additionalProperties":{"type":"object"},"type":"object"},{"type":"null"}],"title":"Integrations","description":"Related integrations for the resource. The key is the unique code of the integration in Qargo","examples":[{"addsecure1234":{"active":true,"object_id":"1234"}}]},"billing_entity":{"anyOf":[{"$ref":"#/components/schemas/BillingEntity"},{"type":"null"}],"description":"Billing entity associated with the resource"},"extras":{"items":{"$ref":"#/components/schemas/ResourceExtraOutput"},"type":"array","title":"Extras","description":"Stop extras this resource is compatible with"},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Active","description":"Is the resource active"},"is_external_resource":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is External Resource","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Read-only. True if this is a non-owned (subcontractor) resource. When this resource appears inside a trip, name / license_plate / container_number reflect the per-trip override value if one was set on the resource allocation; otherwise the resource master value is returned. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the value is not yet projected — treat as internal for backwards compatibility."},"children":[]}]}]}],"examples":[true]},"timestamp_updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp Updated","description":"Timestamp of the last update of the resource"},"resource_groups":{"items":{"$ref":"#/components/schemas/ResourceGroupOutput"},"type":"array","title":"Resource Groups","description":"Resource groups this resource currently belongs to (deduplicated and sorted by name). A resource can belong to more than one group. Active allocations are included regardless of their validity window (scheduled, future, or expired); archived allocations are excluded."},"trailer":{"anyOf":[{"$ref":"#/components/schemas/TrailerProperties-Output"},{"type":"null"}],"description":"Trailer specific properties"}},"type":"object","required":["row_id","name"],"title":"TrailerResourceOutput"}},"components/schemas/TransitDeclarationTypeEnum":{"id":"components/schemas/TransitDeclarationTypeEnum","kind":"json-schema","title":"TransitDeclarationTypeEnum","data":{"type":"string","enum":["T1","T2"],"title":"TransitDeclarationTypeEnum"}},"components/schemas/TransitOffice":{"id":"components/schemas/TransitOffice","kind":"json-schema","title":"TransitOffice","data":{"properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Customs office code"}},"type":"object","title":"TransitOffice"}},"components/schemas/TransporeonConsignmentExtraFields":{"id":"components/schemas/TransporeonConsignmentExtraFields","kind":"json-schema","title":"TransporeonConsignmentExtraFields","data":{"properties":{"delivery_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Delivery Id","description":"Transporeon Delivery ID"}},"type":"object","title":"TransporeonConsignmentExtraFields"}},"components/schemas/TransporeonOrderExtraFields":{"id":"components/schemas/TransporeonOrderExtraFields","kind":"json-schema","title":"TransporeonOrderExtraFields","data":{"properties":{"transport_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transport Id","description":"Transporeon Transport ID"},"transport_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transport Number","description":"Transporeon Transport Number"}},"type":"object","title":"TransporeonOrderExtraFields"}},"components/schemas/TransportType":{"id":"components/schemas/TransportType","kind":"json-schema","title":"TransportType","data":{"properties":{"driver_type":{"$ref":"#/components/schemas/DriverMode","description":"Whether the transport is accompanied or unaccompanied."},"number_of_drivers":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Number Of Drivers","description":"Number of drivers required for the transport."}},"type":"object","required":["driver_type"],"title":"TransportType"}},"components/schemas/TripCostsOutput":{"id":"components/schemas/TripCostsOutput","kind":"json-schema","title":"TripCostsOutput","data":{"properties":{"charges":{"items":{"$ref":"#/components/schemas/ChargeOutput"},"type":"array","title":"Charges"}},"type":"object","required":["charges"],"title":"TripCostsOutput"}},"components/schemas/TripImportInput":{"id":"components/schemas/TripImportInput","kind":"json-schema","title":"TripImportInput","data":{"properties":{"trip_identifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Trip Identifier","description":"External identifier for the trip"},"status":{"anyOf":[{"$ref":"#/components/schemas/TripImportStatus"},{"type":"null"}],"description":"Status of the trip import"},"planned_stops":{"items":{"$ref":"#/components/schemas/TripImportStop"},"type":"array","title":"Planned Stops","description":"List of planned stops in the trip"},"start_timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Timestamp","description":"Start timestamp of the trip in UTC"},"primary_resources":{"anyOf":[{"items":{"$ref":"#/components/schemas/TripImportResource"},"type":"array"},{"type":"null"}],"title":"Primary Resources","description":"List of primary resources assigned to the trip"},"unassigned_stops":{"anyOf":[{"items":{"$ref":"#/components/schemas/TripImportUnassignedStop"},"type":"array"},{"type":"null"}],"title":"Unassigned Stops","description":"List of stops that couldn't be assigned to any resource"},"failure":{"anyOf":[{"$ref":"#/components/schemas/ErrorStatus"},{"type":"null"}],"description":"Error details if the trip import failed upstream"}},"type":"object","required":["planned_stops"],"title":"TripImportInput"}},"components/schemas/TripImportLocation":{"id":"components/schemas/TripImportLocation","kind":"json-schema","title":"TripImportLocation","data":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"ID of the location in Qargo"}},"type":"object","title":"TripImportLocation"}},"components/schemas/TripImportResource":{"id":"components/schemas/TripImportResource","kind":"json-schema","title":"TripImportResource","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"ID of the resource in Qargo"}},"type":"object","required":["id"],"title":"TripImportResource"}},"components/schemas/TripImportResponse":{"id":"components/schemas/TripImportResponse","kind":"json-schema","title":"TripImportResponse","data":{"properties":{"errors":{"anyOf":[{"items":{"$ref":"#/components/schemas/ErrorStatus"},"type":"array"},{"type":"null"}],"title":"Errors","description":"List of errors that occurred during the webhook processing. If empty/omitted, the webhook was processed successfully.","examples":[{"error_message":"The payload is invalid.","error_type":"USER_INPUT_ERROR"},{"error_message":"Not supported.","error_type":"NOT_SUPPORTED"},{"error_message":"Unknown error.","error_type":"INTERNAL_ERROR"}]}},"type":"object","title":"TripImportResponse"}},"components/schemas/TripImportStatus":{"id":"components/schemas/TripImportStatus","kind":"json-schema","title":"TripImportStatus","data":{"type":"string","enum":["CANCELLED"],"title":"TripImportStatus"}},"components/schemas/TripImportStop":{"id":"components/schemas/TripImportStop","kind":"json-schema","title":"TripImportStop","data":{"properties":{"sequence":{"type":"integer","title":"Sequence","description":"Sequence number determining the order of stops"},"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"ID of the stop in Qargo"},"location":{"anyOf":[{"$ref":"#/components/schemas/TripImportLocation"},{"type":"null"}],"description":"Location of the stop"},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"Custom fields for the stop"},"start_timestamp":{"type":"string","format":"date-time","title":"Start Timestamp","description":"Start timestamp of the stop in UTC"},"end_timestamp":{"type":"string","format":"date-time","title":"End Timestamp","description":"End timestamp of the stop in UTC"},"fixed_timestamp_type":{"anyOf":[{"$ref":"#/components/schemas/FixedTimestampType"},{"type":"null"}],"description":"Type of fixed timestamp constraint on the stop"},"question_answers":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Question Answers","description":"Question answers, format to be defined between Qargo and external party"}},"type":"object","required":["sequence","start_timestamp","end_timestamp"],"title":"TripImportStop"}},"components/schemas/TripImportUnassignedStop":{"id":"components/schemas/TripImportUnassignedStop","kind":"json-schema","title":"TripImportUnassignedStop","data":{"properties":{"stop_id":{"type":"string","format":"uuid","title":"Stop Id","description":"ID of the stop that couldn't be assigned"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason","description":"Reason for not being able to assign the stop"}},"type":"object","required":["stop_id"],"title":"TripImportUnassignedStop"}},"components/schemas/TripMatch":{"id":"components/schemas/TripMatch","kind":"json-schema","title":"TripMatch","data":{"properties":{"name":{"anyOf":[{"$ref":"#/components/schemas/FieldMatchInput"},{"type":"null"}]}},"type":"object","title":"TripMatch"}},"components/schemas/TripMetrics":{"id":"components/schemas/TripMetrics","kind":"json-schema","title":"TripMetrics","data":{"properties":{"co2e_tank_to_wheel_kg":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Co2E Tank To Wheel Kg","description":"CO2 equivalent emissions (tank-to-wheel) in kilograms"},"co2e_well_to_tank_kg":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Co2E Well To Tank Kg","description":"CO2 equivalent emissions (well-to-tank) in kilograms"},"co2e_well_to_wheel_kg":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Co2E Well To Wheel Kg","description":"CO2 equivalent emissions (well-to-wheel) in kilograms"},"distance_total_km":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Distance Total Km","description":"Total distance in kilometers"}},"type":"object","title":"TripMetrics"}},"components/schemas/TripOutput":{"id":"components/schemas/TripOutput","kind":"json-schema","title":"TripOutput","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"ID of the trip"},"name":{"type":"string","title":"Name","description":"Name of the trip"},"status":{"$ref":"#/components/schemas/TripStatusOutput","description":"Status of the trip"},"orders":{"items":{"$ref":"#/components/schemas/MinimalOrderOutput"},"type":"array","title":"Orders","description":"List of orders associated with the trip"},"resource_allocations":{"items":{"$ref":"#/components/schemas/ResourceAllocation-Output"},"type":"array","title":"Resource Allocations","description":"List of resources allocated to the trip"},"stops":{"items":{"$ref":"#/components/schemas/TripStopOutput"},"type":"array","title":"Stops","description":"List of stops associated with the trip"},"metrics":{"anyOf":[{"$ref":"#/components/schemas/TripMetrics"},{"type":"null"}],"description":"Trip distance and emission metrics"},"shipment_planning_group":{"anyOf":[{"$ref":"#/components/schemas/PlanningGroup"},{"type":"null"}],"description":"Planning group linked to the trip"}},"type":"object","required":["id","name","status","orders","stops"],"title":"TripOutput"}},"components/schemas/TripStatus":{"id":"components/schemas/TripStatus","kind":"json-schema","title":"TripStatus","data":{"type":"string","enum":["DRAFT","TEMPLATE","BLOCKED","TO_PLAN","PLANNED","DISPATCHED","IN_PROGRESS","COMPLETED","CANCELLED","IGNORED"],"title":"TripStatus"}},"components/schemas/TripStatusOutput":{"id":"components/schemas/TripStatusOutput","kind":"json-schema","title":"TripStatusOutput","data":{"type":"string","enum":["CREATED","PLANNED","COMPLETED"],"title":"TripStatusOutput"}},"components/schemas/TripStopOutput":{"id":"components/schemas/TripStopOutput","kind":"json-schema","title":"TripStopOutput","data":{"properties":{"activity_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Activity Label","description":"Activity to execute at this location, ie. pickup/collect, couple/uncouple trailer"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"Additional freeform data for this stop"},"reference_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"stop reference number"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number"},"mobile_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mobile Number"},"time_window":{"anyOf":[{"$ref":"#/components/schemas/TimeWindow"},{"type":"null"}],"title":"time_window"},"planning_instructions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Planning Instructions","description":"Additional freeform instructions for the planner."},"extras":{"anyOf":[{"items":{"$ref":"#/components/schemas/StopExtra"},"type":"array"},{"type":"null"}],"title":"Extras","description":"Additional services/options for stop"},"custom_fields":{"type":"object","title":"Custom Fields","description":"Additional user defined fields to fill in"},"date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date","description":"Requested date of the stop, as shown in the planning UI. Empty for stops without a requested date (e.g. standalone stops).","examples":["2024-12-31"]},"depot":{"anyOf":[{"$ref":"#/components/schemas/StopDepotOutput"},{"type":"null"}],"description":"Depot information for the stop. Only relevant for location bookings (load building)."},"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier for stop"},"location":{"$ref":"#/components/schemas/LocationWithTerminalOutput-Output","description":"Location of the stop"},"mileage_km":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Mileage Km","description":"Mileage in kilometers"},"end_timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Timestamp","description":"End of stop. The value depends on the stop status: the estimated end time until the stop reaches status COMPLETED, after which it is the actual end time reported during execution. ISO 8601 format in UTC.","examples":["2024-12-31T08:15:00Z"]},"start_timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Timestamp","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start of stop. The value depends on the stop status: the estimated start time until the stop reaches status AT_STOP, after which it is the actual start time reported during execution. ISO 8601 format in UTC."},"children":[]}]}]}],"examples":["2024-12-31T08:00:00Z"]},"incidents":{"anyOf":[{"items":{"$ref":"#/components/schemas/Incident"},"type":"array"},{"type":"null"}],"title":"Incidents","description":"List of incidents"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the stop. One of: TEMPLATE, BLOCKED, TO_PLAN, PLANNED, DISPATCHED, ROUTE_TO_STOP, AT_STOP, COMPLETED, CANCELLED, IGNORED."},"children":[]}]}]}],"examples":["PLANNED"]},"order":{"anyOf":[{"$ref":"#/components/schemas/OrderReference"},{"type":"null"}],"description":"Reference to the Order linked to this stop"}},"type":"object","required":["id","location"],"title":"TripStopOutput"}},"components/schemas/TripUpdate":{"id":"components/schemas/TripUpdate","kind":"json-schema","title":"TripUpdate","data":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id"},"type":{"type":"string","const":"Trip","title":"Type"},"status":{"$ref":"#/components/schemas/VisibilityTripStatus"}},"type":"object","required":["type","status"],"title":"TripUpdate","description":"Send update event on trip status transitions."}},"components/schemas/TruckProperties-Input":{"id":"components/schemas/TruckProperties-Input","kind":"json-schema","title":"TruckProperties","data":{"properties":{"capacity_pallet_spaces":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Capacity Pallet Spaces","description":"Capacity of the truck in pallet spaces","examples":[10]},"capacity_volume_m3":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Capacity Volume M3","description":"Capacity of the truck in cubic meters","examples":[10]},"capacity_weight_kg":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Capacity Weight Kg","description":"Capacity of the truck in kg","examples":[10000]},"tare_weight_kg":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Tare Weight Kg","description":"Tare weight of the truck in kg","examples":[10000]},"exterior_length_m":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Exterior Length M","description":"Exterior length of the truck in meter","examples":[10]},"exterior_width_m":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Exterior Width M","description":"Exterior width of the truck in meter","examples":[5]},"exterior_height_m":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Exterior Height M","description":"Exterior height of the truck in meter","examples":[3]},"gross_weight_vehicle_rating_weight_kg":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Gross Weight Vehicle Rating Weight Kg","description":"Gross weight vehicle rating weight of the truck in kg","examples":[10]},"license_plate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"License Plate","description":"License plate of the truck"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"Model of the truck"},"manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Manufacturer","description":"Manufacturer of the truck"},"vin_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vin Number","description":"VIN number of the truck"},"axle_configuration":{"anyOf":[{"type":"string","enum":["AC_4_X_2","AC_4_X_4","AC_6_X_2","AC_6_X_4","AC_6_X_6","AC_8_X_2","AC_8_X_4","AC_8_X_6","AC_10_X_4","AC_12_X_4"]},{"type":"null"}],"title":"Axle Configuration","description":"Axle configuration of the truck"},"emission_class":{"anyOf":[{"type":"string","enum":["EURO_1","EURO_2","EURO_3","EURO_4","EURO_5","EURO_6"]},{"type":"null"}],"title":"Emission Class","description":"Emission class of the truck"},"fuel_type":{"anyOf":[{"type":"string","enum":["DIESEL","BIOFUELS","LPG","ELECTRIC","HYBRID_ELECTRIC"]},{"type":"null"}],"title":"Fuel Type","description":"Fuel type of the truck"},"roof_type":{"anyOf":[{"type":"string","enum":["CLOSED","OPEN","FLATBED"]},{"type":"null"}],"title":"Roof Type","description":"Roof type of the truck"}},"type":"object","title":"TruckProperties"}},"components/schemas/TruckProperties-Output":{"id":"components/schemas/TruckProperties-Output","kind":"json-schema","title":"TruckProperties","data":{"properties":{"capacity_pallet_spaces":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Capacity Pallet Spaces","description":"Capacity of the truck in pallet spaces","examples":[10]},"capacity_volume_m3":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Capacity Volume M3","description":"Capacity of the truck in cubic meters","examples":[10]},"capacity_weight_kg":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Capacity Weight Kg","description":"Capacity of the truck in kg","examples":[10000]},"tare_weight_kg":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tare Weight Kg","description":"Tare weight of the truck in kg","examples":[10000]},"exterior_length_m":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Exterior Length M","description":"Exterior length of the truck in meter","examples":[10]},"exterior_width_m":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Exterior Width M","description":"Exterior width of the truck in meter","examples":[5]},"exterior_height_m":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Exterior Height M","description":"Exterior height of the truck in meter","examples":[3]},"gross_weight_vehicle_rating_weight_kg":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Gross Weight Vehicle Rating Weight Kg","description":"Gross weight vehicle rating weight of the truck in kg","examples":[10]},"license_plate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"License Plate","description":"License plate of the truck"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"Model of the truck"},"manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Manufacturer","description":"Manufacturer of the truck"},"vin_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vin Number","description":"VIN number of the truck"},"axle_configuration":{"anyOf":[{"type":"string","enum":["AC_4_X_2","AC_4_X_4","AC_6_X_2","AC_6_X_4","AC_6_X_6","AC_8_X_2","AC_8_X_4","AC_8_X_6","AC_10_X_4","AC_12_X_4"]},{"type":"null"}],"title":"Axle Configuration","description":"Axle configuration of the truck"},"emission_class":{"anyOf":[{"type":"string","enum":["EURO_1","EURO_2","EURO_3","EURO_4","EURO_5","EURO_6"]},{"type":"null"}],"title":"Emission Class","description":"Emission class of the truck"},"fuel_type":{"anyOf":[{"type":"string","enum":["DIESEL","BIOFUELS","LPG","ELECTRIC","HYBRID_ELECTRIC"]},{"type":"null"}],"title":"Fuel Type","description":"Fuel type of the truck"},"roof_type":{"anyOf":[{"type":"string","enum":["CLOSED","OPEN","FLATBED"]},{"type":"null"}],"title":"Roof Type","description":"Roof type of the truck"}},"type":"object","title":"TruckProperties"}},"components/schemas/TruckResourceInput":{"id":"components/schemas/TruckResourceInput","kind":"json-schema","title":"TruckResourceInput","data":{"properties":{"is_archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Archived","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reactivate a previously archived resource, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to archive it. Only takes effect when included in the request; omit it to leave the archive state unchanged."},"children":[]}]}]}]},"billing_entity":{"anyOf":[{"$ref":"#/components/schemas/BillingEntityReference"},{"type":"null"}],"description":"Billing entity associated with the resource, defaults to default billing entity if not provided"},"extras":{"anyOf":[{"items":{"$ref":"#/components/schemas/ResourceExtraInput"},"type":"array"},{"type":"null"}],"title":"Extras","description":"Stop extras this resource is compatible with. Replaces the existing list when provided. Send an empty list to clear all compatible extras."},"name":{"type":"string","title":"Name","description":"Name of the resource"},"external_id":{"type":"string","title":"External Id","description":"External identifier of the resource","default":""},"locale":{"anyOf":[{"type":"string","pattern":"^[a-z]{2}(-[A-Z]{2})?$"},{"type":"null"}],"title":"Locale","description":"Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.","examples":["en","nl","en-GB","fr-BE"]},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code of the resource"},"note":{"type":"string","title":"Note","description":"Note about the resource","default":""},"custom_fields":{"type":"object","title":"Custom Fields","description":"User defined additional fields for this resource"},"subcontractor":{"anyOf":[{"$ref":"#/components/schemas/CompanyReference"},{"type":"null"}],"description":"Company linked to the resource"},"integrations":{"anyOf":[{"additionalProperties":{"type":"object"},"type":"object"},{"type":"null"}],"title":"Integrations","description":"Related integrations for the resource. The key is the unique code of the integration in Qargo","examples":[{"addsecure1234":{"active":true,"object_id":"1234"}}]},"truck":{"anyOf":[{"$ref":"#/components/schemas/TruckProperties-Input"},{"type":"null"}],"description":"Truck specific properties"}},"type":"object","required":["name"],"title":"TruckResourceInput"}},"components/schemas/TruckResourceOutput":{"id":"components/schemas/TruckResourceOutput","kind":"json-schema","title":"TruckResourceOutput","data":{"properties":{"row_id":{"type":"string","format":"uuid","title":"Row Id","description":"Identifier of the reference"},"name":{"type":"string","title":"Name","description":"Name of the resource"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":"External identifier of the resource"},"locale":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Locale","description":"Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.","examples":["en","nl","en-GB","fr-BE"]},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code of the resource"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"Note about the resource"},"custom_fields":{"type":"object","title":"Custom Fields","description":"User defined additional fields for this resource"},"subcontractor":{"anyOf":[{"$ref":"#/components/schemas/CompanyReference"},{"type":"null"}],"description":"Company linked to the resource"},"integrations":{"anyOf":[{"additionalProperties":{"type":"object"},"type":"object"},{"type":"null"}],"title":"Integrations","description":"Related integrations for the resource. The key is the unique code of the integration in Qargo","examples":[{"addsecure1234":{"active":true,"object_id":"1234"}}]},"billing_entity":{"anyOf":[{"$ref":"#/components/schemas/BillingEntity"},{"type":"null"}],"description":"Billing entity associated with the resource"},"extras":{"items":{"$ref":"#/components/schemas/ResourceExtraOutput"},"type":"array","title":"Extras","description":"Stop extras this resource is compatible with"},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Active","description":"Is the resource active"},"is_external_resource":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is External Resource","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Read-only. True if this is a non-owned (subcontractor) resource. When this resource appears inside a trip, name / license_plate / container_number reflect the per-trip override value if one was set on the resource allocation; otherwise the resource master value is returned. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the value is not yet projected — treat as internal for backwards compatibility."},"children":[]}]}]}],"examples":[true]},"timestamp_updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp Updated","description":"Timestamp of the last update of the resource"},"resource_groups":{"items":{"$ref":"#/components/schemas/ResourceGroupOutput"},"type":"array","title":"Resource Groups","description":"Resource groups this resource currently belongs to (deduplicated and sorted by name). A resource can belong to more than one group. Active allocations are included regardless of their validity window (scheduled, future, or expired); archived allocations are excluded."},"truck":{"anyOf":[{"$ref":"#/components/schemas/TruckProperties-Output"},{"type":"null"}],"description":"Truck specific properties"}},"type":"object","required":["row_id","name"],"title":"TruckResourceOutput"}},"components/schemas/UnavailabilityReason":{"id":"components/schemas/UnavailabilityReason","kind":"json-schema","title":"UnavailabilityReason","data":{"type":"string","enum":["DRIVER_FUNERAL","DRIVER_HOLIDAY","DRIVER_JOB_APPLICATION_LEAVE","DRIVER_LATE_START_EARLY_LEAVE","DRIVER_MEDICAL_EXAM","DRIVER_OFF_SHIFT_PATTERN","DRIVER_OTHER","DRIVER_PARENTAL_LEAVE","DRIVER_PUBLIC_HOLIDAY","DRIVER_RECUP","DRIVER_REDUCED_WORKING_HOURS_SCHEME","DRIVER_SHIFT_PATTERN","DRIVER_SICKNESS","DRIVER_SOCIAL_LEAVE","DRIVER_TEMPORARY_UNEMPLOYMENT","DRIVER_TRAINING","DRIVER_UNAUTHORISED_ABSENCE","DRIVER_UNION_LEAVE","DRIVER_WORK_ACCIDENT","VEHICLE_BRAKE_TEST","VEHICLE_CLEANING","VEHICLE_FRC_CERTIFICATE","VEHICLE_HIRE","VEHICLE_HYDRAULIC_INSPECTION","VEHICLE_INSPECTION","VEHICLE_LIFT_OPS_EQUIP_REGULATIONS","VEHICLE_MAINTENANCE","VEHICLE_MOT_TEST","VEHICLE_OFF_ROAD","VEHICLE_OTHER","VEHICLE_PRESSURE_TEST","VEHICLE_REPAIR","VEHICLE_SERVICE","VEHICLE_TACHOGRAPH_CALIBRATION","SUBCONTRACTOR_HOLIDAY","SUBCONTRACTOR_SICKNESS","SUBCONTRACTOR_OTHER"],"title":"UnavailabilityReason"}},"components/schemas/UpdateBarcodeInput":{"id":"components/schemas/UpdateBarcodeInput","kind":"json-schema","title":"UpdateBarcodeInput","data":{"properties":{"value":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Value"},"source":{"type":"string","const":"EXTERNAL","title":"Source","default":"EXTERNAL"}},"type":"object","title":"UpdateBarcodeInput"}},"components/schemas/UpdateDropCollectEmptyInput":{"id":"components/schemas/UpdateDropCollectEmptyInput","kind":"json-schema","title":"UpdateDropCollectEmptyInput","data":{"properties":{"requested_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Requested Date"},"location":{"anyOf":[{"$ref":"#/components/schemas/LocationInput"},{"type":"null"}]}},"type":"object","title":"UpdateDropCollectEmptyInput"}},"components/schemas/UpdateOperation":{"id":"components/schemas/UpdateOperation","kind":"json-schema","title":"UpdateOperation","data":{"type":"string","enum":["REPLACE","CREATE","UPDATE","DELETE"],"title":"UpdateOperation","description":"Operation type for partial order structural updates."}},"components/schemas/UpdateOrderPricingInput":{"id":"components/schemas/UpdateOrderPricingInput","kind":"json-schema","title":"UpdateOrderPricingInput","data":{"properties":{"requested_price":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Requested Price"}},"type":"object","title":"UpdateOrderPricingInput"}},"components/schemas/UploadStatus":{"id":"components/schemas/UploadStatus","kind":"json-schema","title":"UploadStatus","data":{"type":"string","enum":["TODO","IN_PROGRESS","READY_TO_UPSERT","UPSERT_IN_PROGRESS","COMPLETED","ERROR","SKIPPED","DUPLICATE"],"title":"UploadStatus"}},"components/schemas/UploadedCompanyDocumentWithValidity":{"id":"components/schemas/UploadedCompanyDocumentWithValidity","kind":"json-schema","title":"UploadedCompanyDocumentWithValidity","data":{"properties":{"upload_id":{"type":"string","format":"uuid","title":"Upload Id","description":"Unique identifier of the uploaded file"},"document_type":{"anyOf":[{"$ref":"#/components/schemas/CustomerDocumentTypeInput"},{"$ref":"#/components/schemas/SubcontractorDocumentWithoutValidityTypeInput"},{"$ref":"#/components/schemas/SubcontractorDocumentWithValidityTypeInput"},{"$ref":"#/components/schemas/SubcontractorInsuranceDocumentTypeInput"}],"title":"Document Type","description":"Type of the document"},"name":{"type":"string","title":"Name","description":"Name of the document"},"validity":{"anyOf":[{"$ref":"#/components/schemas/CompanyValidity"},{"type":"null"}],"description":"Validity information associated with the uploaded document."}},"type":"object","required":["upload_id","document_type","name"],"title":"UploadedCompanyDocumentWithValidity"}},"components/schemas/UploadedDocumentBase_Union_ContainerDocumentTypes__DriverDocumentTypes__VehicleDocumentTypes__":{"id":"components/schemas/UploadedDocumentBase_Union_ContainerDocumentTypes__DriverDocumentTypes__VehicleDocumentTypes__","kind":"json-schema","title":"UploadedDocumentBase[Union[ContainerDocumentTypes, DriverDocumentTypes, VehicleDocumentTypes]]","data":{"properties":{"upload_id":{"type":"string","format":"uuid","title":"Upload Id","description":"Unique identifier of the uploaded file"},"document_type":{"anyOf":[{"$ref":"#/components/schemas/ContainerDocumentTypes"},{"$ref":"#/components/schemas/DriverDocumentTypes"},{"$ref":"#/components/schemas/VehicleDocumentTypes"}],"title":"Document Type","description":"Type of the document"},"name":{"type":"string","title":"Name","description":"Name of the document"}},"type":"object","required":["upload_id","document_type","name"],"title":"UploadedDocumentBase[Union[ContainerDocumentTypes, DriverDocumentTypes, VehicleDocumentTypes]]"}},"components/schemas/UploadedDocumentBase_Union_SubcontractorDocumentWithValidityTypeInput__SubcontractorInsuranceDocumentTypeInput__":{"id":"components/schemas/UploadedDocumentBase_Union_SubcontractorDocumentWithValidityTypeInput__SubcontractorInsuranceDocumentTypeInput__","kind":"json-schema","title":"UploadedDocumentBase[Union[SubcontractorDocumentWithValidityTypeInput, SubcontractorInsuranceDocumentTypeInput]]","data":{"properties":{"upload_id":{"type":"string","format":"uuid","title":"Upload Id","description":"Unique identifier of the uploaded file"},"document_type":{"anyOf":[{"$ref":"#/components/schemas/SubcontractorDocumentWithValidityTypeInput"},{"$ref":"#/components/schemas/SubcontractorInsuranceDocumentTypeInput"}],"title":"Document Type","description":"Type of the document"},"name":{"type":"string","title":"Name","description":"Name of the document"}},"type":"object","required":["upload_id","document_type","name"],"title":"UploadedDocumentBase[Union[SubcontractorDocumentWithValidityTypeInput, SubcontractorInsuranceDocumentTypeInput]]"}},"components/schemas/ValidationError":{"id":"components/schemas/ValidationError","kind":"json-schema","title":"ValidationError","data":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"components/schemas/VanProperties-Input":{"id":"components/schemas/VanProperties-Input","kind":"json-schema","title":"VanProperties","data":{"properties":{"capacity_pallet_spaces":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Capacity Pallet Spaces","description":"Capacity of the van in pallet spaces","examples":[10]},"capacity_volume_m3":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Capacity Volume M3","description":"Capacity of the van in cubic meters","examples":[10]},"capacity_weight_kg":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Capacity Weight Kg","description":"Capacity of the van in kg","examples":[10000]},"tare_weight_kg":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Tare Weight Kg","description":"Tare weight of the van in kg","examples":[10000]},"exterior_length_m":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Exterior Length M","description":"Exterior length of the van in meter","examples":[10]},"exterior_width_m":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Exterior Width M","description":"Exterior width of the van in meter","examples":[5]},"exterior_height_m":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Exterior Height M","description":"Exterior height of the van in meter","examples":[3]},"gross_weight_vehicle_rating_weight_kg":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Gross Weight Vehicle Rating Weight Kg","description":"Gross weight vehicle rating weight of the van in kg","examples":[10]},"license_plate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"License Plate","description":"License plate of the van"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"Model of the van"},"manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Manufacturer","description":"Manufacturer of the van"},"vin_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vin Number","description":"VIN number of the van"},"axle_configuration":{"anyOf":[{"type":"string","enum":["AC_4_X_2","AC_4_X_4","AC_6_X_2","AC_6_X_4","AC_6_X_6","AC_8_X_2","AC_8_X_4","AC_8_X_6","AC_10_X_4","AC_12_X_4"]},{"type":"null"}],"title":"Axle Configuration","description":"Axle configuration of the van"},"emission_class":{"anyOf":[{"type":"string","enum":["EURO_1","EURO_2","EURO_3","EURO_4","EURO_5","EURO_6"]},{"type":"null"}],"title":"Emission Class","description":"Emission class of the van"},"fuel_type":{"anyOf":[{"type":"string","enum":["DIESEL","BIOFUELS","LPG","ELECTRIC","HYBRID_ELECTRIC"]},{"type":"null"}],"title":"Fuel Type","description":"Fuel type of the van"},"roof_type":{"anyOf":[{"type":"string","enum":["CLOSED","OPEN","FLATBED"]},{"type":"null"}],"title":"Roof Type","description":"Roof type of the van"}},"type":"object","title":"VanProperties"}},"components/schemas/VanProperties-Output":{"id":"components/schemas/VanProperties-Output","kind":"json-schema","title":"VanProperties","data":{"properties":{"capacity_pallet_spaces":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Capacity Pallet Spaces","description":"Capacity of the van in pallet spaces","examples":[10]},"capacity_volume_m3":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Capacity Volume M3","description":"Capacity of the van in cubic meters","examples":[10]},"capacity_weight_kg":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Capacity Weight Kg","description":"Capacity of the van in kg","examples":[10000]},"tare_weight_kg":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tare Weight Kg","description":"Tare weight of the van in kg","examples":[10000]},"exterior_length_m":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Exterior Length M","description":"Exterior length of the van in meter","examples":[10]},"exterior_width_m":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Exterior Width M","description":"Exterior width of the van in meter","examples":[5]},"exterior_height_m":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Exterior Height M","description":"Exterior height of the van in meter","examples":[3]},"gross_weight_vehicle_rating_weight_kg":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Gross Weight Vehicle Rating Weight Kg","description":"Gross weight vehicle rating weight of the van in kg","examples":[10]},"license_plate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"License Plate","description":"License plate of the van"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"Model of the van"},"manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Manufacturer","description":"Manufacturer of the van"},"vin_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vin Number","description":"VIN number of the van"},"axle_configuration":{"anyOf":[{"type":"string","enum":["AC_4_X_2","AC_4_X_4","AC_6_X_2","AC_6_X_4","AC_6_X_6","AC_8_X_2","AC_8_X_4","AC_8_X_6","AC_10_X_4","AC_12_X_4"]},{"type":"null"}],"title":"Axle Configuration","description":"Axle configuration of the van"},"emission_class":{"anyOf":[{"type":"string","enum":["EURO_1","EURO_2","EURO_3","EURO_4","EURO_5","EURO_6"]},{"type":"null"}],"title":"Emission Class","description":"Emission class of the van"},"fuel_type":{"anyOf":[{"type":"string","enum":["DIESEL","BIOFUELS","LPG","ELECTRIC","HYBRID_ELECTRIC"]},{"type":"null"}],"title":"Fuel Type","description":"Fuel type of the van"},"roof_type":{"anyOf":[{"type":"string","enum":["CLOSED","OPEN","FLATBED"]},{"type":"null"}],"title":"Roof Type","description":"Roof type of the van"}},"type":"object","title":"VanProperties"}},"components/schemas/VanResourceInput":{"id":"components/schemas/VanResourceInput","kind":"json-schema","title":"VanResourceInput","data":{"properties":{"is_archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Archived","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reactivate a previously archived resource, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to archive it. Only takes effect when included in the request; omit it to leave the archive state unchanged."},"children":[]}]}]}]},"billing_entity":{"anyOf":[{"$ref":"#/components/schemas/BillingEntityReference"},{"type":"null"}],"description":"Billing entity associated with the resource, defaults to default billing entity if not provided"},"extras":{"anyOf":[{"items":{"$ref":"#/components/schemas/ResourceExtraInput"},"type":"array"},{"type":"null"}],"title":"Extras","description":"Stop extras this resource is compatible with. Replaces the existing list when provided. Send an empty list to clear all compatible extras."},"name":{"type":"string","title":"Name","description":"Name of the resource"},"external_id":{"type":"string","title":"External Id","description":"External identifier of the resource","default":""},"locale":{"anyOf":[{"type":"string","pattern":"^[a-z]{2}(-[A-Z]{2})?$"},{"type":"null"}],"title":"Locale","description":"Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.","examples":["en","nl","en-GB","fr-BE"]},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code of the resource"},"note":{"type":"string","title":"Note","description":"Note about the resource","default":""},"custom_fields":{"type":"object","title":"Custom Fields","description":"User defined additional fields for this resource"},"subcontractor":{"anyOf":[{"$ref":"#/components/schemas/CompanyReference"},{"type":"null"}],"description":"Company linked to the resource"},"integrations":{"anyOf":[{"additionalProperties":{"type":"object"},"type":"object"},{"type":"null"}],"title":"Integrations","description":"Related integrations for the resource. The key is the unique code of the integration in Qargo","examples":[{"addsecure1234":{"active":true,"object_id":"1234"}}]},"van":{"anyOf":[{"$ref":"#/components/schemas/VanProperties-Input"},{"type":"null"}],"description":"Van specific properties"}},"type":"object","required":["name"],"title":"VanResourceInput"}},"components/schemas/VanResourceOutput":{"id":"components/schemas/VanResourceOutput","kind":"json-schema","title":"VanResourceOutput","data":{"properties":{"row_id":{"type":"string","format":"uuid","title":"Row Id","description":"Identifier of the reference"},"name":{"type":"string","title":"Name","description":"Name of the resource"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":"External identifier of the resource"},"locale":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Locale","description":"Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.","examples":["en","nl","en-GB","fr-BE"]},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code of the resource"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"Note about the resource"},"custom_fields":{"type":"object","title":"Custom Fields","description":"User defined additional fields for this resource"},"subcontractor":{"anyOf":[{"$ref":"#/components/schemas/CompanyReference"},{"type":"null"}],"description":"Company linked to the resource"},"integrations":{"anyOf":[{"additionalProperties":{"type":"object"},"type":"object"},{"type":"null"}],"title":"Integrations","description":"Related integrations for the resource. The key is the unique code of the integration in Qargo","examples":[{"addsecure1234":{"active":true,"object_id":"1234"}}]},"billing_entity":{"anyOf":[{"$ref":"#/components/schemas/BillingEntity"},{"type":"null"}],"description":"Billing entity associated with the resource"},"extras":{"items":{"$ref":"#/components/schemas/ResourceExtraOutput"},"type":"array","title":"Extras","description":"Stop extras this resource is compatible with"},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Active","description":"Is the resource active"},"is_external_resource":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is External Resource","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Read-only. True if this is a non-owned (subcontractor) resource. When this resource appears inside a trip, name / license_plate / container_number reflect the per-trip override value if one was set on the resource allocation; otherwise the resource master value is returned. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the value is not yet projected — treat as internal for backwards compatibility."},"children":[]}]}]}],"examples":[true]},"timestamp_updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp Updated","description":"Timestamp of the last update of the resource"},"resource_groups":{"items":{"$ref":"#/components/schemas/ResourceGroupOutput"},"type":"array","title":"Resource Groups","description":"Resource groups this resource currently belongs to (deduplicated and sorted by name). A resource can belong to more than one group. Active allocations are included regardless of their validity window (scheduled, future, or expired); archived allocations are excluded."},"van":{"anyOf":[{"$ref":"#/components/schemas/VanProperties-Output"},{"type":"null"}],"description":"Van specific properties"}},"type":"object","required":["row_id","name"],"title":"VanResourceOutput"}},"components/schemas/Vehicle":{"id":"components/schemas/Vehicle","kind":"json-schema","title":"Vehicle","data":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"ID of the resource"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the resource"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code of the resource"},"is_archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Archived","description":"Is the resource archived"},"is_external_resource":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is External Resource","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Read-only. True if this is a non-owned (subcontractor) resource. When this resource appears inside a trip, name / license_plate / container_number reflect the per-trip override value if one was set on the resource allocation; otherwise the resource master value is returned. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the value is not yet projected — treat as internal for backwards compatibility."},"children":[]}]}]}],"examples":[true]},"custom_fields":{"type":"object","title":"Custom Fields","description":"Store values for user defined fields"},"subcontractor":{"anyOf":[{"$ref":"#/components/schemas/CompanyOutput-Input"},{"type":"null"}],"description":"Subcontractor linked to the resource"},"resource_type":{"anyOf":[{"$ref":"#/components/schemas/ResourceTypeEnum"},{"type":"null"}],"description":"Type of the resource"},"axle_configuration":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Axle Configuration","description":"Axle configuration of the vehicle"},"emission_class":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Emission Class","description":"Emission class of the vehicle"},"fuel_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fuel Type","description":"Fuel type of the vehicle"},"license_plate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"License Plate","description":"License plate of the vehicle"},"manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Manufacturer","description":"Manufacturer of the vehicle"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"Model of the vehicle"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"Note about the vehicle"},"roof_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Roof Type","description":"Roof type of the vehicle"},"vin_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vin Number","description":"VIN number of the vehicle"}},"type":"object","title":"Vehicle"}},"components/schemas/VehicleCategory":{"id":"components/schemas/VehicleCategory","kind":"json-schema","title":"VehicleCategory","data":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Human readable identifier"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Machine readable identifier"},"custom_fields":{"type":"object","title":"Custom Fields","description":"Store values for user defined fields"}},"type":"object","title":"VehicleCategory"}},"components/schemas/VehicleDocumentTypes":{"id":"components/schemas/VehicleDocumentTypes","kind":"json-schema","title":"VehicleDocumentTypes","data":{"type":"string","enum":["BRAKE_TEST_CERTIFICATE","CERTIFICATE_OF_CONFORMITY","CITERNE_CLEANING_CERTIFICATE","COMMUNICATION_SUBCONTRACTOR","CONTAINER_TANK_TEST_CERTIFICATE_2Y5","CONTAINER_TANK_TEST_CERTIFICATE_5Y","CONTAINER_TANK_TEST_CERTIFICATE","EUROVIGNET","EXCEPTIONAL_TRANSPORT_LICENSE","FINE","FUEL_CARD","HEAVY_LOAD_BE","HEAVY_LOAD_DE","HEAVY_LOAD_FR","OTHER","OVERSIZE_WL_PERMIT","ROADTAX","TOLL_CARD","VEHICLE_12_WEEKLY_CHECK","VEHICLE_ADR_CERTIFICATE","VEHICLE_ATP_CERTIFICATE","VEHICLE_DAMAGE_REPORT","VEHICLE_FIRE_EXTINGUISHER_SERVICE","VEHICLE_FRC_CERTIFICATE","VEHICLE_FRIDGE_MOTOR","VEHICLE_GERMAN_SECURITY_INSPECTION","VEHICLE_GERMAN_VEHICLE_INSPECTION","VEHICLE_IDENTIFICATION_REPORT","VEHICLE_INSURANCE_CERTIFICATE","VEHICLE_MAINTENANCE_REPORT","VEHICLE_MOT_TEST","VEHICLE_REGISTRATION","VEHICLE_REPAIR_REPORT","VEHICLE_TACHO","VEHICLE_TIR","VEHICLE_TRANSPORT_LICENSE","VEHICLE_UK_HGV_LEVY","XL_CERTIFICATE"],"title":"VehicleDocumentTypes"}},"components/schemas/VehicleMatchInput":{"id":"components/schemas/VehicleMatchInput","kind":"json-schema","title":"VehicleMatchInput","data":{"properties":{"name":{"anyOf":[{"$ref":"#/components/schemas/FieldMatchInput"},{"type":"null"}]},"generic_id":{"anyOf":[{"$ref":"#/components/schemas/FieldMatchInput"},{"type":"null"}]},"integration_object_id":{"anyOf":[{"$ref":"#/components/schemas/FieldMatchInput"},{"type":"null"}],"description":"The resource ID in the given context of your integration. "}},"type":"object","title":"VehicleMatchInput","example":{"generic_id":{"matches_any":["VEH-001"]}}}},"components/schemas/VehicleResource-Input":{"id":"components/schemas/VehicleResource-Input","kind":"json-schema","title":"VehicleResource","data":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"ID of the resource"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the resource"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code of the resource"},"is_archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Archived","description":"Is the resource archived"},"is_external_resource":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is External Resource","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Read-only. True if this is a non-owned (subcontractor) resource. When this resource appears inside a trip, name / license_plate / container_number reflect the per-trip override value if one was set on the resource allocation; otherwise the resource master value is returned. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the value is not yet projected — treat as internal for backwards compatibility."},"children":[]}]}]}],"examples":[true]},"custom_fields":{"type":"object","title":"Custom Fields","description":"Store values for user defined fields"},"subcontractor":{"anyOf":[{"$ref":"#/components/schemas/CompanyOutput-Input"},{"type":"null"}],"description":"Subcontractor linked to the resource"},"resource_type":{"anyOf":[{"$ref":"#/components/schemas/ResourceTypeEnum"},{"type":"null"}],"description":"Type of the resource"},"axle_configuration":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Axle Configuration","description":"Axle configuration of the vehicle"},"emission_class":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Emission Class","description":"Emission class of the vehicle"},"fuel_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fuel Type","description":"Fuel type of the vehicle"},"license_plate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"License Plate","description":"License plate of the vehicle"},"manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Manufacturer","description":"Manufacturer of the vehicle"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"Model of the vehicle"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"Note about the vehicle"},"roof_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Roof Type","description":"Roof type of the vehicle"},"vin_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vin Number","description":"VIN number of the vehicle"}},"type":"object","title":"VehicleResource"}},"components/schemas/VehicleResource-Output":{"id":"components/schemas/VehicleResource-Output","kind":"json-schema","title":"VehicleResource","data":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"ID of the resource"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the resource"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code of the resource"},"is_archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Archived","description":"Is the resource archived"},"is_external_resource":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is External Resource","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Read-only. True if this is a non-owned (subcontractor) resource. When this resource appears inside a trip, name / license_plate / container_number reflect the per-trip override value if one was set on the resource allocation; otherwise the resource master value is returned. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the value is not yet projected — treat as internal for backwards compatibility."},"children":[]}]}]}],"examples":[true]},"custom_fields":{"type":"object","title":"Custom Fields","description":"Store values for user defined fields"},"subcontractor":{"anyOf":[{"$ref":"#/components/schemas/CompanyOutput-Output"},{"type":"null"}],"description":"Subcontractor linked to the resource"},"resource_type":{"anyOf":[{"$ref":"#/components/schemas/ResourceTypeEnum"},{"type":"null"}],"description":"Type of the resource"},"axle_configuration":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Axle Configuration","description":"Axle configuration of the vehicle"},"emission_class":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Emission Class","description":"Emission class of the vehicle"},"fuel_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fuel Type","description":"Fuel type of the vehicle"},"license_plate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"License Plate","description":"License plate of the vehicle"},"manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Manufacturer","description":"Manufacturer of the vehicle"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"Model of the vehicle"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"Note about the vehicle"},"roof_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Roof Type","description":"Roof type of the vehicle"},"vin_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vin Number","description":"VIN number of the vehicle"}},"type":"object","title":"VehicleResource"}},"components/schemas/VisibilityConsignment":{"id":"components/schemas/VisibilityConsignment","kind":"json-schema","title":"VisibilityConsignment","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Consignment ID"},"goods":{"items":{"$ref":"#/components/schemas/VisibilityGood"},"type":"array","title":"Goods","description":"List of goods in this consignment"}},"type":"object","required":["id"],"title":"VisibilityConsignment"}},"components/schemas/VisibilityConsignmentReference":{"id":"components/schemas/VisibilityConsignmentReference","kind":"json-schema","title":"VisibilityConsignmentReference","data":{"properties":{"reference_number":{"type":"string","title":"Reference Number"}},"type":"object","required":["reference_number"],"title":"VisibilityConsignmentReference"}},"components/schemas/VisibilityCustomer":{"id":"components/schemas/VisibilityCustomer","kind":"json-schema","title":"VisibilityCustomer","data":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"Customer ID in Qargo"},"name":{"type":"string","title":"Name","description":"Customer name"},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"User defined additional fields."}},"type":"object","required":["name"],"title":"VisibilityCustomer"}},"components/schemas/VisibilityDimensionByType":{"id":"components/schemas/VisibilityDimensionByType","kind":"json-schema","title":"VisibilityDimensionByType","data":{"properties":{"actual":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Actual","description":"Actual dimension of goods"},"ordered":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Ordered","description":"Ordered dimension of goods"}},"type":"object","title":"VisibilityDimensionByType"}},"components/schemas/VisibilityDocument":{"id":"components/schemas/VisibilityDocument","kind":"json-schema","title":"VisibilityDocument","data":{"properties":{"name":{"type":"string","title":"Name","description":"file name"},"document_type":{"$ref":"#/components/schemas/VisibilityDocumentType"},"document_content":{"anyOf":[{"$ref":"#/components/schemas/RemoteDocument"},{"$ref":"#/components/schemas/EmbeddedDocument"}],"title":"Document Content"},"subject":{"anyOf":[{"$ref":"#/components/schemas/VisibilityOrderReference"},{"$ref":"#/components/schemas/VisibilityConsignmentReference"},{"$ref":"#/components/schemas/VisibilityStopReference"}],"title":"Subject"}},"type":"object","required":["name","document_type","document_content","subject"],"title":"VisibilityDocument"}},"components/schemas/VisibilityDocumentStatus":{"id":"components/schemas/VisibilityDocumentStatus","kind":"json-schema","title":"VisibilityDocumentStatus","data":{"type":"string","enum":["CREATED"],"title":"VisibilityDocumentStatus"}},"components/schemas/VisibilityDocumentType":{"id":"components/schemas/VisibilityDocumentType","kind":"json-schema","title":"VisibilityDocumentType","data":{"type":"string","enum":["CONSIGNEE_SIGNATURE","CUSTOMER_PAPERWORK","PHOTO_OF_GOODS_DELIVERY","PROOF_OF_DELIVERY","PROOF_OF_DELIVERY_SIGNED","PALLET_LABEL","PALLET_LABEL_EXTERNAL","TEMPERATURE_REPORT"],"title":"VisibilityDocumentType"}},"components/schemas/VisibilityEvent":{"id":"components/schemas/VisibilityEvent","kind":"json-schema","title":"VisibilityEvent","data":{"properties":{"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"Event timestamp in UTC. ISO 8601 format.","examples":["2024-12-31T14:30:00Z"]},"update":{"anyOf":[{"$ref":"#/components/schemas/OrderUpdate"},{"$ref":"#/components/schemas/OrderImportUpdate"},{"$ref":"#/components/schemas/StopUpdate"},{"$ref":"#/components/schemas/EtaUpdate"},{"$ref":"#/components/schemas/PositionUpdate"},{"$ref":"#/components/schemas/DocumentUpdate"},{"$ref":"#/components/schemas/TripUpdate"},{"$ref":"#/components/schemas/ResourceUpdate"},{"$ref":"#/components/schemas/HandlingUnitUpdate"}],"title":"Update","description":"Update payload"}},"type":"object","required":["timestamp","update"],"title":"VisibilityEvent"}},"components/schemas/VisibilityGood":{"id":"components/schemas/VisibilityGood","kind":"json-schema","title":"VisibilityGood","data":{"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"quantity":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Quantity"},"total_loading_meters":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Loading Meters"},"total_pallet_spaces":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Pallet Spaces"},"total_volume_m3":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Volume M3"},"total_weight_kg":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Weight Kg"},"unit_height_m":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Height M"},"unit_length_m":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Length M"},"unit_loading_meters":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Loading Meters"},"unit_pallet_spaces":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Pallet Spaces"},"unit_weight_kg":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Weight Kg"},"unit_width_m":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Width M"},"stackable":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Stackable"},"packaged_items":{"items":{"$ref":"#/components/schemas/PackagedItemOutput-Input"},"type":"array","title":"List of packaged items"},"adr_type":{"anyOf":[{"$ref":"#/components/schemas/ADRType"},{"type":"null"}]},"waste_category":{"anyOf":[{"$ref":"#/components/schemas/WasteCategory"},{"type":"null"}]},"absolute_min_temperature_degrees":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Absolute Min Temperature Degrees"},"absolute_max_temperature_degrees":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Absolute Max Temperature Degrees"},"ordered_transport_temperature_degrees":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Ordered Transport Temperature Degrees"},"specific_gravity":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Specific Gravity"},"product":{"anyOf":[{"$ref":"#/components/schemas/Product"},{"type":"null"}],"description":"Product information"},"packaging_type":{"anyOf":[{"$ref":"#/components/schemas/PackagingType"},{"type":"null"}],"description":"Packaging type, for example Pallet"},"extras":{"anyOf":[{"items":{"$ref":"#/components/schemas/ExtraField"},"type":"array"},{"type":"null"}],"title":"Extras","description":"Additional extra services/options for good"},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Custom Fields"},"hs_codes":{"anyOf":[{"$ref":"#/components/schemas/GoodHSCodesExtraFields"},{"type":"null"}]},"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier for this good"},"incidents":{"anyOf":[{"items":{"$ref":"#/components/schemas/Incident"},"type":"array"},{"type":"null"}],"title":"Incidents","description":"List of incidents"},"handling_units":{"anyOf":[{"items":{"$ref":"#/components/schemas/HandlingUnitOutput-Input"},"type":"array"},{"type":"null"}],"title":"Handling Units","description":"List of handling units. A handling unit is used to transport, store or handle goods"},"actual_delivery_temperature_degrees":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Actual Delivery Temperature Degrees"},"actual_pickup_temperature_degrees":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Actual Pickup Temperature Degrees"},"quantity_by_type":{"anyOf":[{"$ref":"#/components/schemas/VisibilityQuantityByType"},{"type":"null"}],"description":"Quantity of goods by type (actual and ordered)"},"total_weight_kg_by_type":{"anyOf":[{"$ref":"#/components/schemas/VisibilityDimensionByType"},{"type":"null"}],"description":"Total weight in kg by type (actual and ordered)"},"total_volume_m3_by_type":{"anyOf":[{"$ref":"#/components/schemas/VisibilityDimensionByType"},{"type":"null"}],"description":"Total volume in m3 by type (actual and ordered)"},"total_loading_meters_by_type":{"anyOf":[{"$ref":"#/components/schemas/VisibilityDimensionByType"},{"type":"null"}],"description":"Total loading meters by type (actual and ordered)"},"total_pallet_spaces_by_type":{"anyOf":[{"$ref":"#/components/schemas/VisibilityDimensionByType"},{"type":"null"}],"description":"Total pallet spaces by type (actual and ordered)"}},"type":"object","required":["id"],"title":"VisibilityGood"}},"components/schemas/VisibilityHandlingUnitStatus":{"id":"components/schemas/VisibilityHandlingUnitStatus","kind":"json-schema","title":"VisibilityHandlingUnitStatus","data":{"type":"string","enum":["SCANNED_IN","STORED","SCANNED_OUT"],"title":"VisibilityHandlingUnitStatus"}},"components/schemas/VisibilityLocation":{"id":"components/schemas/VisibilityLocation","kind":"json-schema","title":"VisibilityLocation","data":{"properties":{"name":{"type":"string","title":"Name","default":"","examples":["Qargo"]},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address","examples":["Gaston Crommenlaan 4"]},"address_second_line":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address Second Line","examples":[""]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","examples":["Ghent"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","examples":[""]},"country_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country Code","examples":["BE"]},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Postal Code","examples":["9050"]},"position":{"anyOf":[{"$ref":"#/components/schemas/Position"},{"type":"null"}]}},"type":"object","title":"VisibilityLocation"}},"components/schemas/VisibilityOrder":{"id":"components/schemas/VisibilityOrder","kind":"json-schema","title":"VisibilityOrder","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Order ID in Qargo"},"order_name":{"type":"string","title":"Order Name","description":"Order name in Qargo","examples":["INV-7980"]},"customer_reference_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Reference Number","description":"Customer reference"},"customer":{"anyOf":[{"$ref":"#/components/schemas/VisibilityCustomer"},{"type":"null"}],"description":"Customer details"},"status":{"$ref":"#/components/schemas/VisibilityOrderStatus","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of an order. We only send an update for the following status updates:"},"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":"ACCEPTED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REJECTED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COMPLETED"},"children":[]}]}]}]}]},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Custom Fields"},"stops":{"items":{"$ref":"#/components/schemas/VisibilityStop"},"type":"array","title":"Stops","description":"Stops included in this order"},"consignment":{"anyOf":[{"$ref":"#/components/schemas/VisibilityConsignment"},{"type":"null"}],"description":"Consignment details for this order"}},"type":"object","required":["id","order_name","status","stops"],"title":"VisibilityOrder"}},"components/schemas/VisibilityOrderImportStatus":{"id":"components/schemas/VisibilityOrderImportStatus","kind":"json-schema","title":"VisibilityOrderImportStatus","data":{"type":"string","enum":["IGNORED"],"title":"VisibilityOrderImportStatus"}},"components/schemas/VisibilityOrderReference":{"id":"components/schemas/VisibilityOrderReference","kind":"json-schema","title":"VisibilityOrderReference","data":{"properties":{"customer_reference_number":{"type":"string","title":"Customer Reference Number"}},"type":"object","required":["customer_reference_number"],"title":"VisibilityOrderReference"}},"components/schemas/VisibilityOrderStatus":{"id":"components/schemas/VisibilityOrderStatus","kind":"json-schema","title":"VisibilityOrderStatus","data":{"type":"string","enum":["ACCEPTED","REJECTED","COMPLETED","DRAFT","QUOTE","BLOCKED","TO_PLAN","PLANNED","DEPARTED","IN_TRANSIT","INVOICE_READY","DONT_INVOICE","INVOICE_CREATED","INVOICED","INVOICE_POSTED","CANCELLED"],"title":"VisibilityOrderStatus"}},"components/schemas/VisibilityQuantityByType":{"id":"components/schemas/VisibilityQuantityByType","kind":"json-schema","title":"VisibilityQuantityByType","data":{"properties":{"actual":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Actual","description":"Actual quantity of goods"},"ordered":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Ordered","description":"Ordered quantity of goods"}},"type":"object","title":"VisibilityQuantityByType"}},"components/schemas/VisibilityResource":{"id":"components/schemas/VisibilityResource","kind":"json-schema","title":"VisibilityResource","data":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"Resource ID in Qargo"},"type":{"$ref":"#/components/schemas/ResourceType"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"license_plate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"License Plate"},"container_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Container Number"}},"type":"object","required":["type"],"title":"VisibilityResource","description":"Represents a resource: van, tractor, trailer and container."}},"components/schemas/VisibilityStop":{"id":"components/schemas/VisibilityStop","kind":"json-schema","title":"VisibilityStop","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Stop ID in Qargo"},"location":{"$ref":"#/components/schemas/VisibilityLocation"},"resources":{"anyOf":[{"items":{"$ref":"#/components/schemas/VisibilityResource"},"type":"array"},{"type":"null"}],"title":"Resources","description":"Resources involved on this stop"},"status":{"$ref":"#/components/schemas/VisibilityStopStatus"},"stop_type":{"$ref":"#/components/schemas/VisibilityStopType"},"eta_start_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Eta Start Time","description":"Estimated arrival time (ETA) at the stop in UTC. ISO 8601 format.","examples":["2024-12-31T14:30:00Z"]},"eta_end_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Eta End Time","description":"Estimated departure time (ETD) from the stop in UTC. ISO 8601 format.","examples":["2024-12-31T16:00:00Z"]},"actual_start_timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Actual Start Timestamp","description":"Actual arrival timestamp in UTC. ISO 8601 format.","examples":["2024-12-31T14:45:00Z"]},"actual_end_timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Actual End Timestamp","description":"Actual departure timestamp in UTC. ISO 8601 format.","examples":["2024-12-31T15:30:00Z"]},"stop_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stop Reference"},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"User-defined custom fields for the stop."}},"type":"object","required":["id","location","status","stop_type"],"title":"VisibilityStop"}},"components/schemas/VisibilityStopReference":{"id":"components/schemas/VisibilityStopReference","kind":"json-schema","title":"VisibilityStopReference","data":{"properties":{"reference_number":{"type":"string","title":"Reference Number"}},"type":"object","required":["reference_number"],"title":"VisibilityStopReference"}},"components/schemas/VisibilityStopStatus":{"id":"components/schemas/VisibilityStopStatus","kind":"json-schema","title":"VisibilityStopStatus","data":{"type":"string","enum":["TO_PLAN","DISPATCHED","ROUTE_TO_STOP","PLANNED","TODO","AT_STOP","COMPLETED","CANCELLED"],"title":"VisibilityStopStatus"}},"components/schemas/VisibilityStopType":{"id":"components/schemas/VisibilityStopType","kind":"json-schema","title":"VisibilityStopType","data":{"type":"string","enum":["PICKUP","DELIVERY","CUSTOM"],"title":"VisibilityStopType"}},"components/schemas/VisibilityTrip":{"id":"components/schemas/VisibilityTrip","kind":"json-schema","title":"VisibilityTrip","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Trip ID in Qargo"},"name":{"type":"string","title":"Name","description":"Trip name in Qargo"},"orders":{"anyOf":[{"items":{"$ref":"#/components/schemas/VisibilityOrder"},"type":"array"},{"type":"null"}],"title":"Orders","description":"Orders included in this trip. This field is not populated by default. Including it requires a custom webhook format configured by Qargo."},"stops":{"items":{"$ref":"#/components/schemas/VisibilityStop"},"type":"array","title":"Stops","description":"Stops included in this trip"}},"type":"object","required":["id","name","stops"],"title":"VisibilityTrip"}},"components/schemas/VisibilityTripStatus":{"id":"components/schemas/VisibilityTripStatus","kind":"json-schema","title":"VisibilityTripStatus","data":{"type":"string","enum":["CREATED","PLANNED","COMPLETED"],"title":"VisibilityTripStatus"}},"components/schemas/WasteCategory":{"id":"components/schemas/WasteCategory","kind":"json-schema","title":"WasteCategory","data":{"type":"string","enum":["WASTE","DANGEROUS_WASTE"],"title":"WasteCategory"}},"components/schemas/WasteConsistence":{"id":"components/schemas/WasteConsistence","kind":"json-schema","title":"WasteConsistence","data":{"type":"string","enum":["SOLID","LIQUID","GASEOUS","DOUGHY"],"title":"WasteConsistence"}},"components/schemas/WasteEmitterType":{"id":"components/schemas/WasteEmitterType","kind":"json-schema","title":"WasteEmitterType","data":{"type":"string","enum":["PRODUCER","OTHER","APPENDIX1","APPENDIX1_PRODUCER","APPENDIX2"],"title":"WasteEmitterType"}},"components/schemas/WeekSchedule":{"id":"components/schemas/WeekSchedule","kind":"json-schema","title":"WeekSchedule","data":{"properties":{"monday":{"anyOf":[{"$ref":"#/components/schemas/DaySchedule"},{"type":"null"}],"description":"Opening hours for Monday."},"tuesday":{"anyOf":[{"$ref":"#/components/schemas/DaySchedule"},{"type":"null"}],"description":"Opening hours for Tuesday."},"wednesday":{"anyOf":[{"$ref":"#/components/schemas/DaySchedule"},{"type":"null"}],"description":"Opening hours for Wednesday."},"thursday":{"anyOf":[{"$ref":"#/components/schemas/DaySchedule"},{"type":"null"}],"description":"Opening hours for Thursday."},"friday":{"anyOf":[{"$ref":"#/components/schemas/DaySchedule"},{"type":"null"}],"description":"Opening hours for Friday."},"saturday":{"anyOf":[{"$ref":"#/components/schemas/DaySchedule"},{"type":"null"}],"description":"Opening hours for Saturday."},"sunday":{"anyOf":[{"$ref":"#/components/schemas/DaySchedule"},{"type":"null"}],"description":"Opening hours for Sunday."}},"type":"object","title":"WeekSchedule"}},"components/schemas/WeekScheduleInput":{"id":"components/schemas/WeekScheduleInput","kind":"json-schema","title":"WeekScheduleInput","data":{"properties":{"monday":{"$ref":"#/components/schemas/DayScheduleInput","description":"Opening hours for Monday."},"tuesday":{"$ref":"#/components/schemas/DayScheduleInput","description":"Opening hours for Tuesday."},"wednesday":{"$ref":"#/components/schemas/DayScheduleInput","description":"Opening hours for Wednesday."},"thursday":{"$ref":"#/components/schemas/DayScheduleInput","description":"Opening hours for Thursday."},"friday":{"$ref":"#/components/schemas/DayScheduleInput","description":"Opening hours for Friday."},"saturday":{"$ref":"#/components/schemas/DayScheduleInput","description":"Opening hours for Saturday."},"sunday":{"$ref":"#/components/schemas/DayScheduleInput","description":"Opening hours for Sunday."}},"type":"object","required":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"],"title":"WeekScheduleInput"}},"components/schemas/api__accounting__models__company__CompanyReferenceOutput":{"id":"components/schemas/api__accounting__models__company__CompanyReferenceOutput","kind":"json-schema","title":"CompanyReferenceOutput","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The unique identifier of the company."},"name":{"type":"string","title":"Name","description":"Name of the company.","examples":["John Doe"]},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"External reference to this company record","examples":["CUST-001"]}},"type":"object","required":["id","name"],"title":"CompanyReferenceOutput"}},"components/schemas/api__accounting__models__invoice__TaxRate":{"id":"components/schemas/api__accounting__models__invoice__TaxRate","kind":"json-schema","title":"TaxRate","data":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"Unique identifier of the tax rate in Qargo."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the Tax rate in Qargo.","examples":["21%"]},"percentage":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Percentage","examples":[21]},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code of the tax rate item in the accounting software.","examples":["21% VAT"]},"tax_type":{"anyOf":[{"$ref":"#/components/schemas/TaxRateType"},{"type":"null"}],"default":"VAT","examples":["VAT"]}},"type":"object","title":"TaxRate"}},"components/schemas/api__accounting__models__master_data__AccountInput":{"id":"components/schemas/api__accounting__models__master_data__AccountInput","kind":"json-schema","title":"AccountInput","data":{"properties":{"code":{"type":"string","title":"Code","description":"Accounting code (GL / nominal code)."},"name":{"type":"string","title":"Name","description":"Display name of the account."},"billing_entity":{"$ref":"#/components/schemas/BillingEntityReference","description":"Billing entity this account belongs to, referenced by code."},"archived":{"type":"boolean","title":"Archived","description":"Whether this account is archived.","default":false}},"type":"object","required":["code","name","billing_entity"],"title":"AccountInput"}},"components/schemas/api__accounting__models__master_data__AccountOutput":{"id":"components/schemas/api__accounting__models__master_data__AccountOutput","kind":"json-schema","title":"AccountOutput","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier of the record in Qargo."},"archived":{"type":"boolean","title":"Archived","description":"Whether this record has been archived."},"code":{"type":"string","title":"Code","description":"Accounting code (GL / nominal code)."},"name":{"type":"string","title":"Name","description":"Display name of the account."},"billing_entity":{"$ref":"#/components/schemas/BillingEntity","description":"Billing entity this account belongs to."}},"type":"object","required":["id","archived","code","name","billing_entity"],"title":"AccountOutput"}},"components/schemas/api__order__models__charge__AccountInput":{"id":"components/schemas/api__order__models__charge__AccountInput","kind":"json-schema","title":"AccountInput","data":{"properties":{"code":{"type":"string","title":"Code","description":"Code of the general ledger in the accounting software linked to this charge line.","examples":["200"]}},"type":"object","required":["code"],"title":"AccountInput"}},"components/schemas/api__order__models__charge__AccountOutput":{"id":"components/schemas/api__order__models__charge__AccountOutput","kind":"json-schema","title":"AccountOutput","data":{"properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Accounting code"}},"type":"object","title":"AccountOutput"}},"components/schemas/api__order__models__charge__CompanyReferenceOutput":{"id":"components/schemas/api__order__models__charge__CompanyReferenceOutput","kind":"json-schema","title":"CompanyReferenceOutput","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"}},"type":"object","required":["id"],"title":"CompanyReferenceOutput"}},"components/schemas/api__order__models__charge__TaxRate":{"id":"components/schemas/api__order__models__charge__TaxRate","kind":"json-schema","title":"TaxRate","data":{"properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code of the tax rate"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the tax rate"},"percentage":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Percentage","description":"Percentage of the tax rate"},"tax_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tax Type","description":"Type of the tax rate"}},"type":"object","title":"TaxRate"}},"components/schemas/ValidationErrorDetail":{"id":"components/schemas/ValidationErrorDetail","kind":"json-schema","title":"ValidationErrorDetail","data":{"properties":{"message":{"description":"Human-readable summary of this validation failure","title":"Message","type":"string"},"field":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Name of the field that failed validation, if known","title":"Field"},"path":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON path to the field within the request payload (e.g. '$.consignor.address.country')"},"children":[]}]}]}],"title":"Path"},"detail":{"anyOf":[{"type":"string"},{"type":"object"},{"type":"null"}],"default":null,"description":"Additional structured context about the failure, if provided by the backend","title":"Detail"}},"required":["message"],"title":"ValidationErrorDetail","type":"object"}},"components/schemas/ValidationErrorResponse":{"id":"components/schemas/ValidationErrorResponse","kind":"json-schema","title":"ValidationErrorResponse","data":{"properties":{"message":{"description":"Human-readable summary of the validation failure","title":"Message","type":"string"},"errors":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One entry per validation failure. Always present and non-empty — a single failure yields a one-item array, so integrators can handle one and many the same way."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/ValidationErrorDetail"},"minItems":1,"title":"Errors","type":"array"}},"required":["message","errors"],"title":"ValidationErrorResponse","type":"object"}},"schema_89":{"kind":"json-schema","data":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"},"id":"schema_89"},"schema_90":{"kind":"json-schema","data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Archived"},"id":"schema_90"},"schema_91":{"kind":"json-schema","data":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Billing Entity Code"},"id":"schema_91"},"schema_92":{"kind":"json-schema","data":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"id":"schema_92"},"schema_93":{"kind":"json-schema","data":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code:In"},"id":"schema_93"},"schema_94":{"kind":"json-schema","data":{"type":"string","format":"uuid","title":"Id"},"id":"schema_94"},"schema_95":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/CurrencyCode"},{"type":"null"}],"title":"From Currency"},"id":"schema_95"},"schema_96":{"kind":"json-schema","data":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From Currency:In"},"id":"schema_96"},"schema_97":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/CurrencyCode"},{"type":"null"}],"title":"To Currency"},"id":"schema_97"},"schema_98":{"kind":"json-schema","data":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To Currency:In"},"id":"schema_98"},"schema_99":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Exchange Rate Date:Gte"},"id":"schema_99"},"schema_100":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Exchange Rate Date:Lte"},"id":"schema_100"},"schema_101":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Document"},"title":"Response Retrieve Purchase Credit Note Documents V1 Accounting Purchase Credit Note  Id  Documents Get"},"id":"schema_101"},"schema_102":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Document"},"title":"Response Retrieve Purchase Invoice Documents V1 Accounting Purchase Invoice  Id  Documents Get"},"id":"schema_102"},"schema_103":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Document"},"title":"Response Retrieve Sales Credit Note Documents V1 Accounting Sales Credit Note  Id  Documents Get"},"id":"schema_103"},"schema_104":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Document"},"title":"Response Retrieve Sales Invoice Documents V1 Accounting Sales Invoice  Id  Documents Get"},"id":"schema_104"},"schema_105":{"kind":"json-schema","data":{"type":"boolean","default":false,"title":"Direct"},"id":"schema_105"},"schema_106":{"kind":"json-schema","data":{},"id":"schema_106"},"schema_107":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/AccountingVisibilityUpdate"},{"type":"object"}],"title":"Body"},"id":"schema_107"},"schema_108":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated After"},"id":"schema_108"},"schema_109":{"kind":"json-schema","data":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Accounting Customer Code"},"id":"schema_109"},"schema_110":{"kind":"json-schema","data":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Accounting Customer Code:In"},"id":"schema_110"},"schema_111":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Document"},"title":"Response Retrieve Purchase Invoice Documents  Deprecated  V1 Accounting Purchase Invoice  Id  Documents Get"},"id":"schema_111"},"schema_112":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Document"},"title":"Response Retrieve Sales Credit Note Documents  Deprecated  V1 Accounting Sales Credit Note  Id  Documents Get"},"id":"schema_112"},"schema_113":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Document"},"title":"Response Retrieve Sales Invoice Documents  Deprecated  V1 Accounting Sales Invoice  Id  Documents Get"},"id":"schema_113"},"schema_114":{"kind":"json-schema","data":{"type":"string","format":"uuid","title":"Upload Id"},"id":"schema_114"},"schema_115":{"kind":"json-schema","data":{"type":"string","format":"uuid","title":"Order Id"},"id":"schema_115"},"schema_116":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Document"},"title":"Response List Order Documents V1 Orders Order  Order Id  Documents Get"},"id":"schema_116"},"schema_117":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/OperationalVisibilityUpdate"},{"type":"object"}],"title":"Body"},"id":"schema_117"},"schema_118":{"kind":"json-schema","data":{"type":"string","title":"Filename"},"id":"schema_118"},"schema_119":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"binary"},{"type":"object"},{"type":"array","items":{}},{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"},{"type":"null"}],"description":"The document content as binary file data or a JSON message.","title":"File"},"id":"schema_119"},"schema_120":{"kind":"json-schema","data":{"type":"string","title":"Question Path Key"},"id":"schema_120"},"schema_121":{"kind":"json-schema","data":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stop Id"},"id":"schema_121"},"schema_122":{"kind":"json-schema","data":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stop Group Id"},"id":"schema_122"},"schema_123":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"binary"},{"type":"object"},{"type":"array","items":{}},{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"},{"type":"null"}],"description":"A single binary file or JSON message","title":"File"},"id":"schema_123"},"schema_124":{"kind":"json-schema","data":{"type":"string","title":"Stop Id"},"id":"schema_124"},"schema_125":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/PurchaseEInvoiceInput"},{"$ref":"#/components/schemas/PurchaseECreditNoteInput"},{"type":"string","format":"binary"}],"title":"Body"},"id":"schema_125"},"schema_126":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/FleetDispatch"},{"type":"string"}],"title":"Body"},"id":"schema_126"},"schema_127":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/FleetDispatchResponse"},{"type":"null"}],"title":"Response Fleet-Dispatch-Payload"},"id":"schema_127"},"schema_128":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/IntermodalBookingStatusPayload"},{"type":"string"}],"title":"Body"},"id":"schema_128"},"schema_129":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/IntermodalBookingsPushPayload"},{"type":"string"}],"title":"Body"},"id":"schema_129"},"schema_130":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/LocationBookingUpdateResponse"},{"type":"null"}],"title":"Response Location-Booking-Update-Webhook"},"id":"schema_130"},"schema_131":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/LocationDispatchOutput"},{"type":"string"}],"title":"Body"},"id":"schema_131"},"schema_132":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/LocationBookingDispatchResponse"},{"type":"null"}],"title":"Response Location-Dispatch-Payload"},"id":"schema_132"},"schema_133":{"kind":"json-schema","data":{"type":"string","format":"uuid","title":"Company Id"},"id":"schema_133"},"schema_134":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Time"},"id":"schema_134"},"schema_135":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Time"},"id":"schema_135"},"schema_136":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Document"},"title":"Response Get Company Validity Documents V1 Companies Company  Company Id  Validity  Id  Documents Get"},"id":"schema_136"},"schema_137":{"kind":"json-schema","data":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id"},"id":"schema_137"},"schema_138":{"kind":"json-schema","data":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id:In"},"id":"schema_138"},"schema_139":{"kind":"json-schema","data":{"type":"string","format":"uuid","title":"Location Id"},"id":"schema_139"},"schema_140":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/DriverResourceInput"},{"$ref":"#/components/schemas/TractorResourceInput"},{"$ref":"#/components/schemas/TruckResourceInput"},{"$ref":"#/components/schemas/VanResourceInput"},{"$ref":"#/components/schemas/TrailerResourceInput"},{"$ref":"#/components/schemas/FullTrailerResourceInput"},{"$ref":"#/components/schemas/ChassisResourceInput"},{"$ref":"#/components/schemas/ContainerResourceInput"}],"title":"Body"},"id":"schema_140"},"schema_141":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/DriverResourceOutput"},{"$ref":"#/components/schemas/TractorResourceOutput"},{"$ref":"#/components/schemas/TruckResourceOutput"},{"$ref":"#/components/schemas/VanResourceOutput"},{"$ref":"#/components/schemas/TrailerResourceOutput"},{"$ref":"#/components/schemas/FullTrailerResourceOutput"},{"$ref":"#/components/schemas/ChassisResourceOutput"},{"$ref":"#/components/schemas/ContainerResourceOutput"}],"title":"Response Create Resource V1 Resources Resource Post"},"id":"schema_141"},"schema_142":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ResourceTypeEnum"},{"type":"null"}],"title":"Resource Type"},"id":"schema_142"},"schema_143":{"kind":"json-schema","data":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Resource Type:In"},"id":"schema_143"},"schema_144":{"kind":"json-schema","data":{"type":"string","format":"uuid","title":"Resource Id"},"id":"schema_144"},"schema_145":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/DriverResourceOutput"},{"$ref":"#/components/schemas/TractorResourceOutput"},{"$ref":"#/components/schemas/TruckResourceOutput"},{"$ref":"#/components/schemas/VanResourceOutput"},{"$ref":"#/components/schemas/TrailerResourceOutput"},{"$ref":"#/components/schemas/FullTrailerResourceOutput"},{"$ref":"#/components/schemas/ChassisResourceOutput"},{"$ref":"#/components/schemas/ContainerResourceOutput"}],"title":"Response Update Resource V1 Resources Resource  Resource Id  Put"},"id":"schema_145"},"schema_146":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/PartialDriverResourceInput"},{"$ref":"#/components/schemas/PartialTractorResourceInput"},{"$ref":"#/components/schemas/PartialTruckResourceInput"},{"$ref":"#/components/schemas/PartialVanResourceInput"},{"$ref":"#/components/schemas/PartialTrailerResourceInput"},{"$ref":"#/components/schemas/PartialFullTrailerResourceInput"},{"$ref":"#/components/schemas/PartialChassisResourceInput"},{"$ref":"#/components/schemas/PartialBaseResourceInput"}],"title":"Body"},"id":"schema_146"},"schema_147":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/DriverResourceOutput"},{"$ref":"#/components/schemas/TractorResourceOutput"},{"$ref":"#/components/schemas/TruckResourceOutput"},{"$ref":"#/components/schemas/VanResourceOutput"},{"$ref":"#/components/schemas/TrailerResourceOutput"},{"$ref":"#/components/schemas/FullTrailerResourceOutput"},{"$ref":"#/components/schemas/ChassisResourceOutput"},{"$ref":"#/components/schemas/ContainerResourceOutput"}],"title":"Response Patch Resource V1 Resources Resource  Resource Id  Patch"},"id":"schema_147"},"schema_148":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/DriverResourceOutput"},{"$ref":"#/components/schemas/TractorResourceOutput"},{"$ref":"#/components/schemas/TruckResourceOutput"},{"$ref":"#/components/schemas/VanResourceOutput"},{"$ref":"#/components/schemas/TrailerResourceOutput"},{"$ref":"#/components/schemas/FullTrailerResourceOutput"},{"$ref":"#/components/schemas/ChassisResourceOutput"},{"$ref":"#/components/schemas/ContainerResourceOutput"}],"title":"Response Get Resource V1 Resources Resource  Resource Id  Get"},"id":"schema_148"},"schema_149":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Document"},"title":"Response Get Resource Validity Documents V1 Resources Resource  Resource Id  Validity  Id  Documents Get"},"id":"schema_149"},"schema_150":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/OrderInput"},{"type":"string","format":"binary"}],"title":"Body"},"id":"schema_150"},"schema_151":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/OrderImportResponse"},{"type":"null"}],"title":"Response Order-Import-Webhook"},"id":"schema_151"},"schema_152":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/PartialOrderUpdateResponse"},{"type":"null"}],"title":"Response Partial-Order-Update"},"id":"schema_152"},"schema_153":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/SubcontractorDispatch"},{"type":"string"}],"title":"Body"},"id":"schema_153"},"schema_154":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/SubcontractorDispatchResponse"},{"type":"null"}],"title":"Response Subcontractor-Dispatch-Payload"},"id":"schema_154"},"schema_155":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/TrackingUpdateResponse"},{"type":"null"}],"title":"Response Tracking-Update"},"id":"schema_155"},"schema_156":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/TripImportInput"},{"type":"string","format":"binary"}],"title":"Body"},"id":"schema_156"},"schema_157":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/TripImportResponse"},{"type":"null"}],"title":"Response Trip-Import-Webhook"},"id":"schema_157"},"schema_158":{"kind":"json-schema","data":{"type":"string","format":"uuid","title":"Trip Id"},"id":"schema_158"},"schema_159":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Document"},"title":"Response Get Trip Documents V1 Trips Trip  Trip Id  Documents Get"},"id":"schema_159"},"schema_160":{"kind":"json-schema","data":{"type":"object","title":"Response Who Am I Me Get"},"id":"schema_160"}},"exampleStore":{},"securitySchemeStore":{"oAuth2ClientCredentials":{"id":"oAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/auth/token"}}},"BasicAuthWebhookCredentials":{"id":"BasicAuthWebhookCredentials","type":"http","scheme":"basic"}},"servers":[{"url":"https://api.qargo.com"}]},"options":{"codeSamples":{"skipOptionalParameters":true,"languages":[{"lang":"Payload"},{"lang":"Python"},{"lang":"JavaScript","label":"JS"},{"lang":"C#"},{"lang":"Java"},{"lang":"curl","label":"cURL"}]},"hideSidebar":true,"mockServer":{"errorIfForcedExampleNotFound":true,"strictExamples":true,"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/docs.json?download"},{"url":"/_bundle/docs.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Qargo TMS API","description":"For support, please contact integrations@qargo.com.\n# Overview\n\n<div style=\"background: linear-gradient(135deg, #1C2C31 0%, #304045 100%); color: white; padding: 20px; border-radius: 10px; margin: 20px 0;\">\n  <h2 style=\"color: white; margin-top: 0;\">Tenant API Documentation</h2>\n  <p style=\"font-size: 16px; margin-bottom: 0;\">You are currently viewing the <strong>Tenant API Documentation</strong>. This API provides access to tenant-level integrations and operational endpoints.</p>\n</div>\n\n<div style=\"border-left: 4px solid #00E85B; background: #F4FBF7; padding: 14px 18px; border-radius: 6px; margin: 20px 0;\">\n  <strong>What's new</strong> — see the <a href=\"/docs/section/changelog\">Changelog</a> for recent additions and changes to the API.\n</div>\n\n<br/>\n\n### Documentation for Other Parties\n\n<div style=\"display: grid; grid-template-columns: repeat(auto-fit, minmax(300px, 1fr)); gap: 20px; margin: 30px 0;\">\n\n<div style=\"border: 2px solid #00E85B; border-radius: 10px; padding: 20px; background: #F4FBF7; transition: transform 0.2s;\">\n  <h3 style=\"color: #36BB6B; margin-top: 0;\">Subcontractor API</h3>\n  <p>Fleet dispatch and subcontractor-specific endpoints for transportation management.</p>\n  <div style=\"text-align: center; margin-top: 15px;\">\n    <a href=\"https://api-docs.qargo.com/subcontractor/docs\" style=\"\n      display: inline-block;\n      background: #00E85B;\n      color: white;\n      padding: 12px 24px;\n      text-decoration: none;\n      border-radius: 6px;\n      font-weight: bold;\n      transition: background 0.3s;\n    \">Subcontractor Documentation</a>\n  </div>\n</div>\n\n<div style=\"border: 2px solid #6F82FB; border-radius: 10px; padding: 20px; background: #F4FBF7; transition: transform 0.2s;\">\n  <h3 style=\"color: #6F82FB; margin-top: 0;\">Customer API</h3>\n  <p>Customer portal endpoints for order tracking, status monitoring, and customer-facing operations.</p>\n  <div style=\"text-align: center; margin-top: 15px;\">\n    <a href=\"https://api-docs.qargo.com/customer/docs\" style=\"\n      display: inline-block;\n      background: #6F82FB;\n      color: white;\n      padding: 12px 24px;\n      text-decoration: none;\n      border-radius: 6px;\n      font-weight: bold;\n      transition: background 0.3s;\n    \">Customer Documentation</a>\n  </div>\n</div>\n\n</div>\n\n# Authentication\n\nThe api requires oauth2 authentication with client id/secret. This should only be used for service to service communication.\n\n## Creating application credentials\n\nApplication client credentials can be created by users with the `Super admin` role in the Qargo application.\nUsers can create and remove application clients by navigating to Configuration -> Organisation Settings (API clients sections).\n\nApplications need to be linked to a valid integration id, identifying the Qargo approved integrator.\nPlease contact [us](mailto:integrations@qargo.com) if you don't have an id yet.\n\n## Obtaining an access token\n\nTo interact with the API, you need a valid access token in JWT (JSON Web Token) format. This token authenticates your requests and authorizes access to protected endpoints. The process involves using Basic Authentication to request the token via the `/auth/token` endpoint.\n\nThe [/auth/token endpoint](/docs/section/authentication/the-api-call-to-request-tokens) can be used to generate an access token (JWT):\n\nThis token will need to be refreshed after expiration (we provide the 'expires_in' in the token response to check validity).\n\n### Understanding Basic Authentication\n\nBasic Authentication is a simple HTTP authentication scheme that allows clients to provide credentials (such as a client ID and secret) directly in the request header. It works by encoding the credentials in Base64 and including them in the `Authorization` header of the HTTP request. For example:\n\n- **Format**: `Authorization: Basic <base64-encoded-credentials>`\n- **Credentials Encoding**: The client ID and secret are concatenated with a colon (e.g., `client_id:secret_id`) and then Base64-encoded.\n\n### The API Call to Request Tokens\n\nThe `/auth/token` endpoint is a POST request used to generate a JWT access token. You authenticate this request using Basic Auth with your provided `client_id` and `secret_id`.\n\n#### Request Details\n\n- **Method**: POST\n- **URL**: `https://api.qargo.com/v1/auth/token`\n- **Headers**:\n  - `Content-Type: application/json`\n  - `Authorization: Basic <base64-encoded-client_id:secret_id>`\n- **Body**: Empty.\n- **Parameters**: None.\n\nExample using `curl`:\n\n```\ncurl -XPOST https://api.qargo.com/v1/auth/token -H 'Content-type: application/json' -u '<client_id:secret_id>'\n```\n\n## Webhook authentication\n\n> **Important:** Webhook endpoints use a **different authentication method** than regular API endpoints. Do not use OAuth tokens for webhooks.\n\nQargo webhooks, such as those for order import and status updates, use **Basic Authentication** instead of OAuth. See [Understanding Basic Authentication](#understanding-basic-authentication) for details on the Basic Auth scheme.\n\nWebhook credentials (client id and secret id) are **provisioned by Qargo** when your webhook integration is configured — contact [integrations@qargo.com](mailto:integrations@qargo.com) to obtain them. They are **separate from your API credentials** and must be used exclusively for webhook endpoints.\n\n### API vs Webhook authentication summary\n\n| | **API endpoints** | **Webhook endpoints** |\n|---|---|---|\n| **Auth method** | OAuth2 (Client Credentials) | Basic Authentication |\n| **Credentials** | API client_id + secret_id → Bearer JWT token | Webhook client_id + secret_id (directly in header) |\n| **Header format** | `Authorization: Bearer <jwt_token>` | `Authorization: Basic <base64(client_id:secret_id)>` |\n| **Where to find credentials** | Configuration → Organisation Settings → API clients | Provisioned by Qargo — contact [integrations@qargo.com](mailto:integrations@qargo.com) |\n| **Token refresh needed?** | Yes (JWT expires) | No (credentials sent with each request) |\n\n### Common mistake\n\nWebhook credentials can technically be used to obtain an OAuth token via the `/auth/token` endpoint, but this token **will not work** for authenticating webhook requests. Always use Basic Authentication with your webhook credentials directly in the `Authorization` header.\n\n### Example webhook request\n\n```\ncurl -XPOST https://api.qargo.com/v1/webhook/order-import \\\n  -H 'Content-Type: application/json' \\\n  -u '<webhook_client_id>:<webhook_secret_id>' \\\n  -d '{ ... }'\n```\n\n# Rate Limits\n\nTo maintain API stability and prevent abuse, we enforce rate limits on a per-tenant basis.\n\n### Limits\n\nThe limits below are estimates based on normal operating conditions. Under increased system load, these limits may be tightened without prior notice to protect API stability.\n\n| **Category** | **Scope** | **Limit** |\n| --- | --- | --- |\n| Authentication | `/auth/token` | 5 requests per hour |\n| General API Usage | All endpoints *except* authentication and webhooks | 2 requests per second (sustained); up to 3 per second (bursts) |\n\n### Enforcement\n\nRate limits are enforced by tracking requests over several sliding time windows-per second, per 10 minutes, and per hour. Exceeding any of these limits will result in an HTTP `429 Too Many Requests` response. The response includes a `Retry-After` header specifying the number of seconds your application should wait before making a new request.\n\n![Timeline showing how to pace API requests, wait with jitter after a 429 response, and retry successfully](https://api.qargo.com/docs/static/rate_limit_timeline.svg)\n\nExample response:\n```http\nHTTP/1.1 429 Too Many Requests\nContent-Type: application/json\nRetry-After: 58\n\n{\"error\":\"Rate limit exceeded\"}\n```\n\nApplications must handle this response correctly by treating `Retry-After` as the minimum delay, regardless of whether the request appeared to be within the estimated limits. If multiple workers or processes can make requests for the same tenant, add a small positive random delay (jitter) after `Retry-After` before retrying. Never subtract jitter or retry earlier than indicated. If another `429` response is returned, repeat this process using the latest `Retry-After` value.\n\nFor any concerns about these limits, please contact us at [integrations@qargo.com](mailto:integrations@qargo.com).\n\n# API Best Practices\n\nThis section outlines recommended practices for efficiently working with the Qargo API.\n\n## Pagination\n\nSome list endpoints support cursor-based pagination. Paginated responses contain `items` and `next_cursor`. When `next_cursor` is not `null`, pass its value unchanged as the `cursor` query parameter in the next request. Do not combine `cursor` with other query parameters.\n\n<br/>\n\n### How pagination works\n\n1. **Initial request**: Make a request to a paginated endpoint without a `cursor` parameter.\n2. **Process the response**: Read the current page from `items`.\n3. **Subsequent requests**: If `next_cursor` is not `null`, pass its value as the `cursor` parameter in the next request.\n4. **Stop**: Repeat until `next_cursor` is `null`.\n\n<br/>\n\n### Example usage\n\n```http\nGET /v1/resources/resource\n```\n\nResponse:\n```json\n{\n  \"items\": [\n    {\n      \"name\": \"Truck 142\",\n      \"row_id\": \"3f9e6b1c-3333-4d2e-b1a4-7c8f9e0a1b03\"\n    }\n  ],\n  \"next_cursor\": \"eyJwYXJhbWV0ZXJzIjp7fSwic3RhdGUiOiJhYmMxMjM0NSIsImN1cnNvcl9zb3J0IjoiMjAyNi0wOC0xMlQxMDowMDowMFoiLCJjdXJzb3JfaWQiOiIzZjllNmIxYy0zMzMzLTRkMmUtYjFhNC03YzhmOWUwYTFiMDMifQ==\"\n}\n```\n\nNext request:\n```http\nGET /v1/resources/resource?cursor=eyJwYXJhbWV0ZXJzIjp7fSwic3RhdGUiOiJhYmMxMjM0NSIsImN1cnNvcl9zb3J0IjoiMjAyNi0wOC0xMlQxMDowMDowMFoiLCJjdXJzb3JfaWQiOiIzZjllNmIxYy0zMzMzLTRkMmUtYjFhNC03YzhmOWUwYTFiMDMifQ==\n```\n\nThe next page can be empty. Continue until the response returns `next_cursor` as `null`.\n\n### Recommendations\n\n- Check that `next_cursor` is not `null` before making another request.\n- Treat cursors as opaque. Do not parse, modify, or construct them.\n- Do not combine `cursor` with other query parameters.\n\n## Backward compatibility\n\nThe Qargo API follows these backward compatibility principles:\n\n- **New fields may be added** to response payloads at any time. Adding new fields is **not** considered a breaking change.\n- **Integrators should ignore unknown fields** when parsing responses. Do not fail on unexpected properties.\n- **Deprecated fields and endpoints** are marked as `deprecated` in this specification. They continue to work but may be removed in a future version. Migrate to the recommended replacement as soon as possible.\n- **Existing fields will not be renamed or removed** without prior notice and a deprecation period.\n\n## Date and time formats\n\nAll date and time fields in the API follow ISO 8601:\n\n| Type | Format | Example | Description |\n|------|--------|---------|-------------|\n| Date | `YYYY-MM-DD` | `2024-12-31` | Calendar date without time component |\n| Datetime | `YYYY-MM-DDTHH:mm:ssZ` | `2024-12-31T14:30:00Z` | Timestamp in UTC (indicated by `Z` suffix) |\n| Time | `HH:mm` | `09:30` | Time of day in 24-hour format |\n\n- **Datetime fields are always in UTC.** Convert to local time on the client side.\n- **Date fields have no timezone.** They represent a calendar date (e.g. a planned delivery date).\n- **Time fields** are used for time windows (e.g. delivery windows) and are in 24-hour format without seconds.\n\n# Concepts\n\n## Company\n\nA company in Qargo can be both a customer as well as a subcontractor (supplier).\nThe entity will have a single id within Qargo. The api client can link companies by this id,\nor by the accounting code, which is a user defined code field.\n\n## Order\n\nTransport order to execute. Also called job in other TMS systems. It contains all transport details:\n\n- Order references\n- Customer [company](/docs/section/concepts/company)\n- Consigments, with their [stop](/docs/section/concepts/stop) locations, time windows, references\n- Definition of the goods to transport\n\n## Stop\n\n- A stop is a part of a transport, at a certain date, optional timeslot and location.\n  In addition to the planned times, it also tracks the actual times for a completed stop.\n  Stops can be linked to [orders](/docs/section/concepts/order), or can be defined standalone (for example a cleaning stop).\n  All stops are linked to a Trip.\n\n### Stop group\n\nStops can be grouped together according to their activity and location. This is called a stop group.\n\n## Trip\n\nA trip contains [stops](/docs/section/concepts/stop) from various [orders](/docs/section/concepts/order), or standalone [stops](/docs/section/concepts/stop). It tracks how a certain\ntransport is planned, and who will execute that transport.\n\n## Task\n\nA task is the primary workflow concept in Qargo. Users can define their own flow,\nusing both built-in tasks as well a custom defined ones. For the current accounting use case,\nwe only expose the `post invoice/credit note` task, that allows users to send invoices to an accounting system.\n\n## Resource\n\nA resource in Qargo is a vehicle, driver, trailer or other entity that can be assigned to a [trip](/docs/section/concepts/trip).\n\n## Unavailability\n\nAn unavailability indicates that a specific [resource](/docs/section/concepts/resource) is not available for use for a given time range. An unavailability has a reason to indicate why the resource is not available.\n\n## Status update\n\nA status update reflects a status change in an entity.\n\n## Document\n\nA document in Qargo can be identified by a unique id. It has a type and is linked to a certain entity (for example an order).\n\n# Postman collection\n\nWe have a [postman](https://www.postman.com/downloads/) collection [available](/docs/postman.json \"download\")\nwith interactive examples (right click to download). Download this to a local folder, and import it into Postman for usage.\n\n### Instructions\n\n- Make sure you have a Postman client available. This can either be a local installed version or the web based version.\n- Request credentials for the Qargo API for order creation\n- Download and import the collection\n- Set the collection variables username and password with the credentials received\n- Execute the Request Access token request in the Authentication folder. You have now a valid access key for 1 hour. If you get the error message that the key is no longer valid, please refresh the access key by invoking this endpoint again.\n- You can now explore the different order endpoints\n\n# Functionality\n\nThe api exposes the following functionality:\n\n- Order management: create/update and get the status of transport orders.\n- Retrieve trip information: retrieve information about Qargo [trips](/docs/section/concepts/trip).\n- Visibility: send events to an external system using webhooks.\n- Order dispatch: send transport orders to a 3rd party using webhooks.\n- Accounting: interface an accounting system using the api endpoints.\n- Documents: interface to download documents\n\n## Order management\n\nAvailable functionality:\n\n- Create [orders](/docs/section/concepts/order) in Qargo and track order status.\n- Export any existing order to be used as a template for future order creation.\n\nThe api reference is available here: [order api](/docs/api-order).\n\n## Trip information\n\n[Trips](/docs/section/concepts/trip) can't be manipulated yet through the api, but it is possible to retrieve trip information.\nWe currently have an endpoint available to retrieve the charge information for a certain endpoint.\n\nYou can update the status of [stops](/docs/section/concepts/stop) and [stop groups](/docs/section/concepts/stop) of a trip using a [webhook](/docs/webhooks-inbound/subcontractor-status-update-webhook).\n\n## Resource management\n\n### Resource\n\n[Resources](/docs/section/concepts/resource) this should be used together with the endpoints to fetch unavailabilities as a resource unavailability is linked to a resource.\n\n### Unavailability\n\n[Resource unavailabilities](/docs/section/concepts/unavailability) can be managed through the API. The following operations are supported:\n\n- Creating an unavailability for a resource\n- Updating an unavailability for a resource\n- Deleting an unavailability for a resource\n- Fetching an unavailability for a resource\n- Fetching all unavailabilities for a resource\n\nThe goal of these endpoints is to allow external systems to manage the availability of resources in Qargo. An `external_id` is stored alongside the unavailability to allow for easy linking between the external system and Qargo. This `external_id` should be provided if a referential link is needed between the external system and Qargo.\n\nSee the [examples](/docs/section/resources/unavailabilities) on how to use the unavailability endpoints.\n\n## Visibility\n\nWe support visibility (sending messages triggered by Qargo system events) in the api as well.\nThese messages can be send out as a [webhook](/docs/webhooks-outbound/operational_visibility_event_webhook_post), or an EDI connection.\n\nFor most endpoints, visibility only trigger on status changes (for example, from stop `IN_PROGRESS` -> `COMPLETED`).\nThere are a few exceptions, these will be indicated in the overview:\n\n- Order level\n  - We send out a visibility event on `ACCEPTED` (order created), `REJECTED` (order skipped) and `COMPLETED` (all stops for order completed).\n- Stop level\n  - We send out a visibility event on `AT_STOP` (arrived at stop), `COMPLETED` (all activities completed for stop).\n- Position level (note: for every telematics update)\n- Trip level\n  - We send a visibility event when a trip changes to `PLANNED` and when it transitions to `COMPLETED`.\n- Resource level\n  - We send an event when a resource is assigned to a certain [trip](/docs/section/concepts/trip).\n\n## Order dispatch\n\nIt is also possible to subcontract trips to other parties. This is possible using two push endpoints:\n\n- Outgoing dispatched trip [payload](/docs/webhooks-outbound/subcontractor-dispatch-payload).\n- Incoming [message format](/docs/webhooks-inbound/subcontractor-status-update-webhook) to update subcontracted status.\n\n\n## Documents\n\nWe offer an interface to download documents. The documents can be fetched using the [document endpoints](/docs/api-document).\n\n## Request additional endpoints\n\nPlease contact [us](mailto:integrations@qargo.com) for inqueries regarding additional api functionality.\n\n# Transport order creation & status\n\nThis sections details how to construct payloads to create transport orders using the order upload endpoint([/orders/order/upload](/docs/api-order/import_order_v1_orders_order_upload_post)).\n\n## Order creation metadata\n\nOrders are not created synchronously via the API. When creating orders via the `POST /orders/order/upload` endpoint, you will receive the following response when creating an order.\n\n```json\n{\n  \"upload_id\": \"<UPLOAD UUID>\",\n  \"upload_status\": \"IN_PROGRESS\",\n  \"upload_url\": \"v1/orders/order/upload/<UPLOAD UUID>\",\n  \"order_id\": null,\n  \"order_url\": null\n}\n```\n\nYou need to store the `upload_id` so you can fetch the status of the order creation by calling `GET /orders/order/upload/<UPLOAD UUID>`\n\nBased on the status of the upload (`upload_status`), you can know if the order is still in the progress of being created or has already been created. Both `order_id` and `order_url` will be filled in when the order has been created. The `order_id` will be filled in with the order id, which can then be used to fetch the order data and status from the system.\n\n**Example payload `GET /orders/order/upload/e01b3db1-4e49-4241-a91e-7534da884d46`** with a created order\n\n```json\n{\n  \"upload_id\": \"e01b3db1-4e49-4241-a91e-7534da884d46\",\n  \"upload_status\": \"COMPLETED\",\n  \"upload_url\": \"v1/orders/order/upload/e01b3db1-4e49-4241-a91e-7534da884d46\",\n  \"order_id\": \"a2a84715-0027-49af-ad30-494c0ccf75cc\",\n  \"order_url\": \"v1/orders/order/a2a84715-0027-49af-ad30-494c0ccf75cc\"\n}\n```\n\n## Order identifier\n\nThe `order_identifier` is used to uniquely identify orders that are being created via the API. This means that the same `order_identifier` needs to be used when updating orders. Multiple identical updates after each other are idempotent and will not fail the request.\n\nThe `order_identifier` main usage is for `deduplication`, you cannot use the `order_identifier` to fetch an order.\n\n## Create an order\n\nThe first example is a simple transport from our london office to our Ghent office.\nPlease note that the transport service will need to be matched with the one in your system.\n\n```json\n{\n  \"operation\": \"CREATE\",\n  \"consignments\": [\n    {\n      \"delivery_stop\": {\n        \"date\": \"2022-05-03\",\n        \"location\": {\n          \"name\": \"Qargo Ghent office\",\n          \"address\": \"Gaston Crommenlaan 4\",\n          \"postal_code\": \"9050\",\n          \"city\": \"Ghent\",\n          \"country\": \"BE\"\n        },\n        \"reference_number\": \"D12345\"\n      },\n      \"pickup_stop\": {\n        \"date\": \"2022-04-21\",\n        \"location\": {\n          \"name\": \"Qargo London office\",\n          \"address\": \"71-91 Aldwych\",\n          \"postal_code\": \"WC2B 4HN\",\n          \"city\": \"London\",\n          \"country\": \"UK\"\n        },\n        \"reference_number\": \"P123456\"\n      }\n    }\n  ],\n  \"customer_reference_number\": \"T12345\",\n  \"customer\": {\n    \"code\": \"00020\"\n  },\n  \"order_identifier\": \"T1234393\",\n  \"transport_service\": {\n    \"name\": \"General\"\n  }\n}\n```\n\nNote: it is possible to 'export' existing orders in the api to use as examples/templates.\nSee the [Export existing orders](/docs/section/transport-order-creation-and-status/export-an-existing-order) section.\n\n## Update an order\n\nThe following order is an update of an existing order. Note the `UPDATE` value of the operation field.\n\nImportant remarks:\n\n- Not all the fields of the order can be updated\n- the `order_identifier` field is used to identify the order to update\n\n**Example of an order update**\n\n```json\n{\n  \"order_identifier\": \"QARGO_TEST_0001\",\n  \"operation\": \"UPDATE\",\n  \"customer\": {\n    \"name\": \"UPS SCS Coventry\"\n  },\n  \"consignments\": [\n    {\n      \"pickup_stop\": {\n        \"location\": {\n          \"name\": \"Qargo HQ\",\n          \"address\": \"Gaston Crommenlaan 4,\",\n          \"postal_code\": \"9000\",\n          \"city\": \"Gent\",\n          \"state\": \"Oost-Vlaanderen\",\n          \"country\": \"BE\",\n          \"description\": \"Qargo HQ building\"\n        },\n        \"note\": \"Pickup 4 boxes of pasta\",\n        \"date\": \"2024-08-20\",\n        \"reference_number\": \"QACOLLI001\",\n        \"planning_instructions\": \"If closed, call mobile number\",\n        \"email\": \"info@qargo.com\",\n        \"phone_number\": \"+0912341431\",\n        \"mobile_number\": \"+324567890\"\n      },\n      \"delivery_stop\": {\n        \"location\": {\n          \"name\": \"Grocery store\",\n          \"address\": \"Resedastraat 20\",\n          \"postal_code\": \"9000\",\n          \"city\": \"Gent\",\n          \"state\": \"Oost-Vlaanderen\",\n          \"country\": \"BE\",\n          \"description\": \"Grocery store\"\n        },\n        \"note\": \"Don't forget to sign the documents\",\n        \"date\": \"2024-08-21\",\n        \"reference_number\": \"QADELIV001\",\n        \"planning_instructions\": \"Alarm code: 123456\",\n        \"email\": \"info@qargo.com\",\n        \"phone_number\": \"02123456\",\n        \"mobile_number\": \"+329998888\"\n      },\n      \"goods\": [\n        {\n          \"description\": \"4 boxes of pasta\",\n          \"quantity\": 4\n        }\n      ]\n    }\n  ],\n  \"customer_reference_number\": \"QARGO_TEST_0001\",\n  \"transport_service\": {\n    \"code\": \"CONTAINER_BOOKING\"\n  }\n}\n```\n\n## Cancel an order\n\nTo cancel an order, pass `DELETE` as `operation` value. This will cancel the order. If the order has already been cancelled, this will not result in an error. Executing multiple cancellations is a idempotent operation and will not fail the request.\n\nA cancelled order cannot be uncancelled. If you need to revert the cancel, you will need to recreate the original order **using a different order identifier**. Using the same order identifier will cause the system to try to update the cancelled order, which results in an error.\n\n```json\n{\n  \"operation\": \"DELETE\",\n  \"consignments\": [\n    {\n      \"delivery_stop\": {\n        \"date\": \"2022-05-03\",\n        \"location\": {\n          \"name\": \"Qargo Ghent office\",\n          \"address\": \"Gaston Crommenlaan 4\",\n          \"postal_code\": \"9050\",\n          \"city\": \"Ghent\",\n          \"country\": \"BE\"\n        },\n        \"reference_number\": \"D12345\"\n      },\n      \"pickup_stop\": {\n        \"date\": \"2022-04-21\",\n        \"location\": {\n          \"name\": \"Qargo London office\",\n          \"address\": \"71-91 Aldwych\",\n          \"postal_code\": \"WC2B 4HN\",\n          \"city\": \"London\",\n          \"country\": \"UK\"\n        },\n        \"reference_number\": \"P123456\"\n      }\n    }\n  ],\n  \"customer_reference_number\": \"T12345\",\n  \"customer\": {\n    \"code\": \"00020\"\n  },\n  \"order_identifier\": \"T1234393\",\n  \"transport_service\": {\n    \"name\": \"General\"\n  }\n}\n```\n\n## Export an existing order\n\nIt is possible to export a manually created order in the api. We first need to determine the technical id of this order.\n\n![Retrieve order id](https://api.qargo.com/docs/static/order_id.png).\n\nThe order can be exported with the following endpoint:\n[Export order](/docs/section/transport-order-creation-and-status/export-an-existing-order).\nThe output of this endpoint corresponds to the order creation format. Just make sure to use a different [`order_identifier`](/docs/section/transport-order-creation-and-status/order-identifier), otherwise the 'new' order will be interpreted as an update.\n\n\n## Fetch order data and status\n\nWith the `GET /orders/order/<ORDER UUID>` [endpoint](/docs/api-order/get_order_details_v1_orders_order__order_id__get), you can fetch the data related to the order. This contains the current `status` of the order along with other data.\n\n## Container orders\n\nThere are 2 types of container orders that can be created using the API, `IMPORT` and `EXPORT`.\n\n### Import\n\nThis scenario contains of 2 main stops additional optional stops.\n\n1. Pickup of a loaded container\n2. Unload container\n3. Drop off empty container (Optional, configured in `teardown_stops`)\n\nThe `container_scenario` property is set as `IMPORT` and the drop off location of the container is specified in the the `teardown_stops` property. The optional `teardown_stops` describe the stops of the container after the consignment has been completed\n\n**Example `IMPORT` container scenario**\n\n```json\n{\n  \"order_identifier\": \"QARGO_TEST_0002\",\n  \"operation\": \"CREATE\",\n  \"customer\": {\n    \"name\": \"UPS SCS Coventry\"\n  },\n  \"teardown_stops\": [\n    {\n      \"location\": {\n        \"name\": \"Container yard\",\n        \"address\": \"Scheepzatestraat 1\",\n        \"postal_code\": \"9000\",\n        \"city\": \"Gent\",\n        \"state\": \"Oost-Vlaanderen\",\n        \"country\": \"BE\"\n      },\n      \"note\": \"Drop off the container on the designated location\",\n      \"date\": \"2024-08-20\",\n      \"reference_number\": \"CONT0001\",\n      \"planning_instructions\": \"Put next to the red container\",\n      \"email\": \"info@qargo.com\",\n      \"phone_number\": \"+0912341431\",\n      \"mobile_number\": \"+324567890\"\n    }\n  ],\n  \"consignments\": [\n    {\n      \"pickup_stop\": {\n        \"location\": {\n          \"name\": \"Container pickup location\",\n          \"address\": \"Gaston Crommenlaan 4,\",\n          \"postal_code\": \"9000\",\n          \"city\": \"Gent\",\n          \"state\": \"Oost-Vlaanderen\",\n          \"country\": \"BE\",\n          \"description\": \"This is the container pickup location\"\n        },\n        \"note\": \"Pick up the green container\",\n        \"date\": \"2024-08-20\",\n        \"reference_number\": \"CONT0002\",\n        \"planning_instructions\": \"Code of the container is 1234\",\n        \"email\": \"info@qargo.com\",\n        \"phone_number\": \"+0912341431\",\n        \"mobile_number\": \"+324567890\"\n      },\n      \"delivery_stop\": {\n        \"location\": {\n          \"name\": \"Sports store\",\n          \"address\": \"Resedastraat 20\",\n          \"postal_code\": \"9000\",\n          \"city\": \"Gent\",\n          \"state\": \"Oost-Vlaanderen\",\n          \"country\": \"BE\",\n          \"description\": \"This is the delivery location of the container goods\"\n        },\n        \"note\": \"1000 boxes of shoes\",\n        \"date\": \"2024-08-21\",\n        \"reference_number\": \"CONT0003\",\n        \"planning_instructions\": \"Use mobile number if gate is closed\",\n        \"email\": \"info@qargo.com\",\n        \"phone_number\": \"02123456\",\n        \"mobile_number\": \"+329998888\"\n      }\n    }\n  ],\n  \"container\": {\n    \"container_scenario\": \"IMPORT\"\n  },\n  \"customer_reference_number\": \"QARGO_TEST_0002\",\n  \"transport_service\": {\n    \"code\": \"CONTAINERS\"\n  }\n}\n```\n\n### Export\n\nThis scenario contains 2 main stops with additional optional stops:\n\n1. Pickup empty container (Optional, configured in `setup_stops`)\n2. Load empty container\n3. Drop off loaded container\n\nThe `container_scenario` is set as `EXPORT` and the `setup_stops` property allows to define additional optional stops.\n\n**Example of an `EXPORT` `container_scenario`**\n\n```json\n{\n  \"order_identifier\": \"QARGO_TEST_0003\",\n  \"operation\": \"CREATE\",\n  \"customer\": {\n    \"name\": \"UPS SCS Coventry\"\n  },\n  \"setup_stops\": [\n    {\n      \"location\": {\n        \"name\": \"Container yard\",\n        \"address\": \"Scheepzatestraat 1\",\n        \"postal_code\": \"9000\",\n        \"city\": \"Gent\",\n        \"state\": \"Oost-Vlaanderen\",\n        \"country\": \"BE\"\n      },\n      \"note\": \"Pickup empty container on the designated location\",\n      \"date\": \"2024-08-20\",\n      \"reference_number\": \"CONT0001\",\n      \"planning_instructions\": \"Blue container, next to the red container\",\n      \"email\": \"info@qargo.com\",\n      \"phone_number\": \"+0912341431\",\n      \"mobile_number\": \"+324567890\"\n    }\n  ],\n  \"consignments\": [\n    {\n      \"pickup_stop\": {\n        \"location\": {\n          \"name\": \"Container loading location\",\n          \"address\": \"Gaston Crommenlaan 4,\",\n          \"postal_code\": \"9000\",\n          \"city\": \"Gent\",\n          \"state\": \"Oost-Vlaanderen\",\n          \"country\": \"BE\",\n          \"description\": \"Qargo HQ, has a container loading bay\"\n        },\n        \"note\": \"Fill with 1000 boxes of Qargo shirts\",\n        \"date\": \"2024-08-20\",\n        \"reference_number\": \"CONT0002\",\n        \"planning_instructions\": \"Code of the container is 1234\",\n        \"email\": \"info@qargo.com\",\n        \"phone_number\": \"+0912341431\",\n        \"mobile_number\": \"+324567890\"\n      },\n      \"delivery_stop\": {\n        \"location\": {\n          \"name\": \"Train station container hub\",\n          \"address\": \"Resedastraat 20\",\n          \"postal_code\": \"9000\",\n          \"city\": \"Gent\",\n          \"state\": \"Oost-Vlaanderen\",\n          \"country\": \"BE\",\n          \"description\": \"This is the dropoff location of the loaded container\"\n        },\n        \"note\": \"1000 boxes of shoes\",\n        \"date\": \"2024-08-21\",\n        \"reference_number\": \"CONT0003\",\n        \"planning_instructions\": \"Use mobile number if gate is closed\",\n        \"email\": \"info@qargo.com\",\n        \"phone_number\": \"02123456\",\n        \"mobile_number\": \"+329998888\"\n      }\n    }\n  ],\n  \"container\": {\n    \"container_scenario\": \"EXPORT\"\n  },\n  \"customer_reference_number\": \"QARGO_TEST_0003\",\n  \"transport_service\": {\n    \"code\": \"CONTAINERS\"\n  }\n}\n```\n\n### Create a loaded container import transport order\n\nThe following order picks up a filled container, delivers it to our office, and returns the empty container.\nThis examples also demonstrates how to model ADR information.\n\n```json\n{\n  \"operation\": \"CREATE\",\n  \"consignments\": [\n    {\n      \"delivery_stop\": {\n        \"location\": {\n          \"name\": \"Qargo Ghent office\",\n          \"address\": \"Gaston Crommenlaan 4\",\n          \"postal_code\": \"9050\",\n          \"city\": \"Ghent\",\n          \"country\": \"BE\"\n        },\n        \"note\": \"unloading address comments\",\n        \"reference_number\": \"D123956\"\n      },\n      \"pickup_stop\": {\n        \"location\": {\n          \"address\": \"Europaweg\",\n          \"city\": \"Rotterdam\",\n          \"country\": \"NL\",\n          \"name\": \"APM terminals Maasvlakte II\"\n        },\n        \"reference_number\": \"P123956\"\n      },\n      \"goods\": [\n        {\n          \"good_items\": {\n            \"adr\": {\n              \"name\": \"DISINFECTANT, LIQUID, CORROSIVE, N.O.S.\",\n              \"un_number\": \"1903\"\n            }\n          },\n          \"ordered_quantity\": 100,\n          \"ordered_total_volume_value\": 43000,\n          \"packaging_type\": {\n            \"code\": \"PYZ\"\n          }\n        }\n      ]\n    }\n  ],\n  \"container_number\": \"MSCU5285725\",\n  \"container_scenario\": \"IMPORT\",\n  \"container_type\": {\n    \"code\": \"22G0\"\n  },\n  \"customer\": {\n    \"code\": \"00083\"\n  },\n  \"customer_reference_number\": \"C2325995\",\n  \"order_identifier\": \"ord-12332423\",\n  \"teardown_input\": [\n    {\n      \"location\": {\n        \"address\": \"Butaanweg 52-54\",\n        \"city\": \"Rotterdam\",\n        \"country\": \"NL\",\n        \"name\": \"OCC Overbeek Cont. Control.\"\n      }\n    }\n  ],\n  \"transport_service\": {\n    \"name\": \"Container\"\n  }\n}\n```\n\n### Create a loaded container export transport order\n\nThis example shows how to create a transport that exports a loaded container.\nThe setup section specifies the empty container pickup.\n\n```json\n{\n  \"operation\": \"CREATE\",\n  \"consignments\": [\n    {\n      \"delivery_stop\": {\n        \"location\": {\n          \"address\": \"Europaweg\",\n          \"city\": \"Rotterdam\",\n          \"country\": \"NL\",\n          \"name\": \"APM terminals Maasvlakte II\"\n        },\n        \"reference_number\": \"3432423908987\"\n      },\n      \"pickup_stop\": {\n        \"location\": {\n          \"name\": \"Qargo Ghent office\",\n          \"address\": \"Gaston Crommenlaan 4\",\n          \"postal_code\": \"9050\",\n          \"city\": \"Ghent\",\n          \"country\": \"BE\"\n        },\n        \"reference_number\": \"3432441\"\n      },\n      \"goods\": [\n        {\n          \"absolute_max_temperature_value\": \"-8.0\",\n          \"description\": \"Plastic buckets\",\n          \"ordered_quantity\": 1500,\n          \"packaging_type\": {\n            \"code\": \"PE\"\n          }\n        }\n      ]\n    }\n  ],\n  \"container_number\": \"MSCU5285725\",\n  \"container_scenario\": \"EXPORT\",\n  \"container_type\": {\n    \"code\": \"22RE\"\n  },\n  \"customer\": {\n    \"code\": \"00007\"\n  },\n  \"customer_reference_number\": \"PUC-888315\",\n  \"order_identifier\": \"d18f8309-0f26-4687-b32b-749008a0cb8e\",\n  \"setup_input\": [\n    {\n      \"location\": {\n        \"address\": \"Butaanweg 52-54\",\n        \"city\": \"Rotterdam\",\n        \"country\": \"NL\",\n        \"name\": \"OCC Overbeek Cont. Control.\"\n      }\n    }\n  ],\n  \"transport_service\": {\n    \"name\": \"Container\"\n  }\n}\n```\n\n## Adding custom stops\n\nIn Qargo you can define custom stop actions. These stops can be added to configure additional stops related to the order.\n\nThese stops can be defined in the `standalone_stops` property.\n\nUsing `standalone_stops` to configure stops adds the following requirements to the order:\n\n1. Every stop needs to have a unique positive integer assigned to it. This will determine the sequence of the stops in the order.\n2. Every stops needs to have a `custom_activity` assigned to it. This will determine the type of stop that is being added to the order.\n\n**Example custom stops for an order**\n\n```json\n{\n  \"import_configuration\": {\n    \"code\": \"API\"\n  },\n  \"transport_service\": {\n    \"code\": \"YOUR_TRANSPORT_SERVICE_CODE\"\n  },\n  \"customer\": {\n    \"code\": \"CUSTOMER_CODE\"\n  },\n  \"operation\": \"CREATE\",\n  \"order_identifier\": \"EXT-ORDER-001\",\n  \"customer_reference_number\": \"CUST-REF-001\",\n  \"consignments\": [\n    {\n      \"pickup_stop\": {\n        \"activity\": \"PICKUP\",\n        \"date\": \"2026-04-01\",\n        \"location\": {\n          \"name\": \"Warehouse Antwerp\",\n          \"address\": \"Kaai 100\",\n          \"city\": \"Antwerp\",\n          \"postal_code\": \"2000\",\n          \"country\": \"BE\"\n        },\n        \"position\": {\n          \"optimal\": true,\n          \"position\": 1\n        }\n      },\n      \"delivery_stop\": {\n        \"activity\": \"DELIVERY\",\n        \"date\": \"2026-04-01\",\n        \"location\": {\n          \"name\": \"Distribution Center Ghent\",\n          \"address\": \"Industrieweg 50\",\n          \"city\": \"Ghent\",\n          \"postal_code\": \"9000\",\n          \"country\": \"BE\"\n        },\n        \"position\": {\n          \"optimal\": true,\n          \"position\": 3\n        }\n      },\n      \"standalone_stops\": [\n        {\n          \"activity\": \"CUSTOM\",\n          \"custom_activity_label\": \"WEEG\",\n          \"date\": \"2026-04-01\",\n          \"location\": {\n            \"name\": \"Weigh Station Mechelen\",\n            \"address\": \"Weegbrug 1\",\n            \"city\": \"Mechelen\",\n            \"postal_code\": \"2800\",\n            \"country\": \"BE\"\n          },\n          \"position\": {\n            \"optimal\": true,\n            \"position\": 2\n          }\n        }\n      ],\n      \"goods\": [\n        {\n          \"description\": \"Palletized goods\",\n          \"quantity\": 10,\n          \"package_type\": \"EURO_PALLET\",\n          \"total_weight\": 5000\n        }\n      ]\n    }\n  ]\n}\n```\n\n**Example custom stops for an container order**\n\n```json\n{\n  \"order_identifier\": \"QARGO_TEST_0005\",\n  \"operation\": \"CREATE\",\n  \"customer\": {\n    \"name\": \"UPS SCS Coventry\"\n  },\n  \"setup_stops\": [\n    {\n      \"location\": {\n        \"name\": \"Stop 1\",\n        \"address\": \"Scheepzatestraat 1\",\n        \"postal_code\": \"9000\",\n        \"city\": \"Gent\",\n        \"state\": \"Oost-Vlaanderen\",\n        \"country\": \"BE\"\n      },\n      \"note\": \"Stop 1 notes\",\n      \"date\": \"2024-08-20\",\n      \"reference_number\": \"Stop 1 reference number\",\n      \"planning_instructions\": \"Stop 1 instructions\",\n      \"email\": \"info@qargo.com\",\n      \"phone_number\": \"+0912341431\",\n      \"mobile_number\": \"+324567890\",\n      \"activity\": \"COLLECT_EMPTY_CONTAINER\",\n      \"position\": {\n        \"position\": 1\n      }\n    }\n  ],\n  \"consignments\": [\n    {\n      \"standalone_stops\": [\n        {\n          \"location\": {\n            \"name\": \"Stop 2\",\n            \"address\": \"Vlierstraat 4,\",\n            \"postal_code\": \"9000\",\n            \"city\": \"Gent\",\n            \"state\": \"Oost-Vlaanderen\",\n            \"country\": \"BE\",\n            \"description\": \"HQ\"\n          },\n          \"note\": \"Stop 2 notes\",\n          \"date\": \"2024-08-20\",\n          \"reference_number\": \"Stop 2 number\",\n          \"planning_instructions\": \"Stop 2 instructions\",\n          \"email\": \"info@qargo.com\",\n          \"phone_number\": \"+0912341431\",\n          \"mobile_number\": \"+324567890\",\n          \"custom_activity\": \"WEGEN\",\n          \"position\": {\n            \"position\": 2\n          }\n        },\n        {\n          \"location\": {\n            \"name\": \"Stop 6\",\n            \"address\": \"Vlierstraat 4,\",\n            \"postal_code\": \"9000\",\n            \"city\": \"Gent\",\n            \"state\": \"Oost-Vlaanderen\",\n            \"country\": \"BE\",\n            \"description\": \"HQ\"\n          },\n          \"note\": \"Stop 6 notes\",\n          \"date\": \"2024-08-20\",\n          \"reference_number\": \"Stop 6 number\",\n          \"planning_instructions\": \"Stop 6 instructions\",\n          \"email\": \"info@qargo.com\",\n          \"phone_number\": \"+0912341431\",\n          \"mobile_number\": \"+324567890\",\n          \"custom_activity\": \"WEGEN\",\n          \"position\": {\n            \"position\": 6\n          }\n        },\n        {\n          \"location\": {\n            \"name\": \"Stop 3\",\n            \"address\": \"Corbiestraat 4,\",\n            \"postal_code\": \"9000\",\n            \"city\": \"Gent\",\n            \"state\": \"Oost-Vlaanderen\",\n            \"country\": \"BE\"\n          },\n          \"note\": \"Stop 3 notes\",\n          \"date\": \"2024-08-22\",\n          \"reference_number\": \"Stop 3 reference number\",\n          \"planning_instructions\": \"Stop 3 instructions\",\n          \"email\": \"info@qargo.com\",\n          \"phone_number\": \"+0912341431\",\n          \"mobile_number\": \"+324567890\",\n          \"custom_activity\": \"INKLAREN\",\n          \"position\": {\n            \"position\": 3\n          }\n        }\n      ],\n      \"pickup_stop\": {\n        \"location\": {\n          \"name\": \"Stop 4\",\n          \"address\": \"Gaston Crommenlaan 4,\",\n          \"postal_code\": \"9000\",\n          \"city\": \"Gent\",\n          \"state\": \"Oost-Vlaanderen\",\n          \"country\": \"BE\",\n          \"description\": \"HQ\"\n        },\n        \"note\": \"Stop 4 notes\",\n        \"date\": \"2024-08-20\",\n        \"reference_number\": \"Stop 4 reference number\",\n        \"planning_instructions\": \"Stop 4 instructions\",\n        \"email\": \"info@qargo.com\",\n        \"phone_number\": \"+0912341431\",\n        \"mobile_number\": \"+324567890\",\n        \"activity\": \"PICKUP_EXPORT\",\n        \"position\": {\n          \"position\": 4\n        }\n      },\n      \"delivery_stop\": {\n        \"location\": {\n          \"name\": \"Stop 5\",\n          \"address\": \"Resedastraat 20\",\n          \"postal_code\": \"9000\",\n          \"city\": \"Gent\",\n          \"state\": \"Oost-Vlaanderen\",\n          \"country\": \"BE\",\n          \"description\": \"Delivery\"\n        },\n        \"note\": \"Stop 5 notes\",\n        \"date\": \"2024-08-21\",\n        \"reference_number\": \"Stop 5 reference number\",\n        \"planning_instructions\": \"Stop 5 instructions\",\n        \"email\": \"info@qargo.com\",\n        \"phone_number\": \"02123456\",\n        \"mobile_number\": \"+329998888\",\n        \"activity\": \"DELIVERY_EXPORT\",\n        \"position\": {\n          \"position\": 5\n        }\n      }\n    }\n  ],\n  \"container\": {\n    \"container_scenario\": \"EXPORT\"\n  },\n  \"customer_reference_number\": \"QARGO_TEST_0005\",\n  \"transport_service\": {\n    \"code\": \"CONTAINER_BOOKING\"\n  }\n}\n```\n\n## Examples\n\n### Basic order\n\n```json\n{\n  \"order_identifier\": \"DEFAULT_ORDER\",\n  \"operation\": \"CREATE\",\n  \"customer\": { \"name\": \"Qargo\" },\n  \"import_configuration\": { \"code\": \"API\" },\n  \"consignments\": [\n    {\n      \"pickup_stop\": {\n        \"location\": {\n          \"name\": \"Qargo\",\n          \"address\": \"Gaston Crommenlaan 4\",\n          \"postal_code\": \"9000\",\n          \"city\": \"Gent\",\n          \"state\": \"Oost-Vlaanderen\",\n          \"country\": \"BE\",\n          \"description\": \"HQ\"\n        },\n        \"note\": \"Collection notes\",\n        \"date\": \"2024-07-19\",\n        \"reference_number\": \"\",\n        \"planning_instructions\": \"\",\n        \"email\": \"\",\n        \"phone_number\": \"\",\n        \"mobile_number\": \"\"\n      },\n      \"delivery_stop\": {\n        \"location\": {\n          \"name\": \"Qargo London\",\n          \"address\": \"71-91 Aldwych\",\n          \"postal_code\": \"WC2B 4HN\",\n          \"city\": \"London\",\n          \"country\": \"GB\",\n          \"description\": \"Delivery\"\n        },\n        \"note\": \"Delivery notes\",\n        \"date\": \"2024-07-19\",\n        \"reference_number\": \"\",\n        \"planning_instructions\": \"\",\n        \"email\": \"\",\n        \"phone_number\": \"\",\n        \"mobile_number\": \"\"\n      },\n      \"goods\": [{ \"quantity\": 1 }]\n    }\n  ],\n  \"customer_reference_number\": \"QARGO-123\",\n  \"transport_service\": { \"code\": \"QARGO\" },\n  \"service_level\": { \"code\": \"QARGO_NEXT_DAY\" }\n}\n```\n\n### Container IMPORT scenario\n\n```json\n{\n  \"order_identifier\": \"CONTAINER_IMPORT_ORDER\",\n  \"operation\": \"CREATE\",\n  \"customer\": { \"name\": \"QARGO\" },\n  \"import_configuration\": { \"code\": \"API\" },\n  \"teardown_stops\": [\n    {\n      \"location\": {\n        \"name\": \"Ghent Container Yard\",\n        \"address\": \"Scheepzatestraat 1\",\n        \"postal_code\": \"9000\",\n        \"city\": \"Gent\",\n        \"state\": \"Oost-Vlaanderen\",\n        \"country\": \"BE\"\n      },\n      \"note\": \"Empty container drop-off\",\n      \"date\": \"2024-08-24\",\n      \"reference_number\": \"\",\n      \"planning_instructions\": \"\",\n      \"email\": \"\",\n      \"phone_number\": \"\",\n      \"mobile_number\": \"\"\n    }\n  ],\n  \"consignments\": [\n    {\n      \"pickup_stop\": {\n        \"location\": {\n          \"name\": \"Qargo Ghent\",\n          \"address\": \"Gaston Crommenlaan 4,\",\n          \"postal_code\": \"9000\",\n          \"city\": \"Gent\",\n          \"state\": \"Oost-Vlaanderen\",\n          \"country\": \"BE\",\n          \"description\": \"\"\n        },\n        \"note\": \"\",\n        \"date\": \"2024-08-20\",\n        \"reference_number\": \"\",\n        \"planning_instructions\": \"\",\n        \"email\": \"\",\n        \"phone_number\": \"\",\n        \"mobile_number\": \"\"\n      },\n      \"delivery_stop\": {\n        \"location\": {\n          \"name\": \"Qargo London\",\n          \"address\": \"71-91 Aldwych\",\n          \"postal_code\": \"WC2B 4HN\",\n          \"city\": \"London\",\n          \"country\": \"GB\",\n          \"description\": \"Delivery\"\n        },\n        \"note\": \"Delivery notes\",\n        \"date\": \"2024-08-22\",\n        \"reference_number\": \"\",\n        \"planning_instructions\": \"\",\n        \"email\": \"\",\n        \"phone_number\": \"\",\n        \"mobile_number\": \"\"\n      }\n    }\n  ],\n  \"container\": { \"container_scenario\": \"IMPORT\", \"seal_number\": \"SEAL12345\" },\n  \"customer_reference_number\": \"QARGO-01\",\n  \"transport_service\": { \"code\": \"CONTAINER_TRANSPORT_SERVICE\" }\n}\n```\n\n### Container EXPORT scenario\n\n```json\n{\n  \"order_identifier\": \"CONTAINER_EXPORT_ORDER\",\n  \"operation\": \"CREATE\",\n  \"customer\": { \"name\": \"QARGO\" },\n  \"import_configuration\": { \"code\": \"API\" },\n  \"setup_stops\": [\n    {\n      \"location\": {\n        \"name\": \"Ghent Container Yard\",\n        \"address\": \"Scheepzatestraat 1\",\n        \"postal_code\": \"9000\",\n        \"city\": \"Gent\",\n        \"state\": \"Oost-Vlaanderen\",\n        \"country\": \"BE\"\n      },\n      \"note\": \"Empty container pickup location\",\n      \"date\": \"2024-08-20\",\n      \"reference_number\": \"\",\n      \"planning_instructions\": \"\",\n      \"email\": \"\",\n      \"phone_number\": \"\",\n      \"mobile_number\": \"\"\n    }\n  ],\n  \"consignments\": [\n    {\n      \"pickup_stop\": {\n        \"location\": {\n          \"name\": \"Qargo Ghent\",\n          \"address\": \"Gaston Crommenlaan 4,\",\n          \"postal_code\": \"9000\",\n          \"city\": \"Gent\",\n          \"state\": \"Oost-Vlaanderen\",\n          \"country\": \"BE\",\n          \"description\": \"\"\n        },\n        \"note\": \"\",\n        \"date\": \"2024-08-20\",\n        \"reference_number\": \"\",\n        \"planning_instructions\": \"\",\n        \"email\": \"\",\n        \"phone_number\": \"\",\n        \"mobile_number\": \"\"\n      },\n      \"delivery_stop\": {\n        \"location\": {\n          \"name\": \"Qargo London\",\n          \"address\": \"71-91 Aldwych\",\n          \"postal_code\": \"WC2B 4HN\",\n          \"city\": \"London\",\n          \"country\": \"GB\",\n          \"description\": \"Delivery\"\n        },\n        \"note\": \"Delivery notes\",\n        \"date\": \"2024-08-22\",\n        \"reference_number\": \"\",\n        \"planning_instructions\": \"\",\n        \"email\": \"\",\n        \"phone_number\": \"\",\n        \"mobile_number\": \"\"\n      }\n    }\n  ],\n  \"container\": { \"container_scenario\": \"EXPORT\", \"seal_number\": \"SEAL12345\" },\n  \"customer_reference_number\": \"QARGO-00003\",\n  \"transport_service\": { \"code\": \"CONTAINER_TRANSPORT_SERVICE\" }\n}\n```\n\n### Order with multiple stops example\n\n```json\n{\n  \"order_identifier\": \"MULTIPLE_STOPS_ORDER\",\n  \"operation\": \"CREATE\",\n  \"customer\": { \"name\": \"QARGO\" },\n  \"consignments\": [\n    {\n      \"standalone_stops\": [\n        {\n          \"location\": {\n            \"name\": \"Customs Ghent\",\n            \"address\": \"Sint-Lievenslaan 27\",\n            \"postal_code\": \"9000\",\n            \"city\": \"Gent\",\n            \"state\": \"Oost-Vlaanderen\",\n            \"country\": \"BE\",\n            \"description\": \"Customs office location\"\n          },\n          \"note\": \"\",\n          \"date\": \"2024-08-20\",\n          \"reference_number\": \"\",\n          \"planning_instructions\": \"\",\n          \"email\": \"\",\n          \"phone_number\": \"\",\n          \"mobile_number\": \"\",\n          \"custom_activity\": \"CUSTOMS\",\n          \"position\": { \"position\": 1 }\n        },\n        {\n          \"location\": {\n            \"name\": \"Truck weight station\",\n            \"address\": \"Belgicastraat 10\",\n            \"postal_code\": \"9000\",\n            \"city\": \"Gent\",\n            \"state\": \"Oost-Vlaanderen\",\n            \"country\": \"BE\",\n            \"description\": \"HQ\"\n          },\n          \"note\": \"\",\n          \"date\": \"2024-08-20\",\n          \"reference_number\": \"\",\n          \"planning_instructions\": \"\",\n          \"email\": \"\",\n          \"phone_number\": \"\",\n          \"mobile_number\": \"\",\n          \"custom_activity\": \"WEIGHT_STATION\",\n          \"position\": { \"position\": 2 }\n        },\n        {\n          \"location\": {\n            \"name\": \"Truckwash Ghent\",\n            \"address\": \"Traktaatweg 23\",\n            \"postal_code\": \"9000\",\n            \"city\": \"Gent\",\n            \"state\": \"Oost-Vlaanderen\",\n            \"country\": \"BE\"\n          },\n          \"note\": \"\",\n          \"date\": \"2024-08-23\",\n          \"reference_number\": \"\",\n          \"planning_instructions\": \"\",\n          \"email\": \"\",\n          \"phone_number\": \"\",\n          \"mobile_number\": \"\",\n          \"custom_activity\": \"WASHING\",\n          \"position\": { \"position\": 5 }\n        }\n      ],\n      \"pickup_stop\": {\n        \"location\": {\n          \"name\": \"Qargo Ghent\",\n          \"address\": \"Gaston Crommenlaan 4,\",\n          \"postal_code\": \"9000\",\n          \"city\": \"Gent\",\n          \"state\": \"Oost-Vlaanderen\",\n          \"country\": \"BE\",\n          \"description\": \"\"\n        },\n        \"note\": \"\",\n        \"date\": \"2024-08-20\",\n        \"reference_number\": \"\",\n        \"planning_instructions\": \"\",\n        \"email\": \"\",\n        \"phone_number\": \"\",\n        \"mobile_number\": \"\",\n        \"activity\": \"PICKUP\",\n        \"position\": { \"position\": 3 }\n      },\n      \"delivery_stop\": {\n        \"location\": {\n          \"name\": \"Qargo London\",\n          \"address\": \"71-91 Aldwych\",\n          \"postal_code\": \"WC2B 4HN\",\n          \"city\": \"London\",\n          \"country\": \"GB\",\n          \"description\": \"Delivery\"\n        },\n        \"note\": \"Delivery notes\",\n        \"date\": \"2024-08-22\",\n        \"reference_number\": \"\",\n        \"planning_instructions\": \"\",\n        \"email\": \"\",\n        \"phone_number\": \"\",\n        \"mobile_number\": \"\",\n        \"activity\": \"DELIVERY\",\n        \"position\": { \"position\": 4 }\n      }\n    }\n  ],\n  \"customer_reference_number\": \"QARGO_001\",\n  \"transport_service\": { \"code\": \"FULL_LOADS\" }\n}\n```\n\n### Order with ADR goods\n\n`technical_name_by_locale` is writable; use it to provide localized technical names for the dangerous goods. Each key\nmust be a supported locale code, and each value is the technical name for that locale. `adr_name_by_locale` is\nread-only; the API generates this field automatically and ignores any submitted value. The example below provides\ntechnical names for four locales.\n\n```json\n{\n  \"order_identifier\": \"DANGEROUS_GOODS_ORDER\",\n  \"operation\": \"CREATE\",\n  \"customer\": { \"name\": \"QARGO\" },\n  \"import_configuration\": { \"code\": \"API\" },\n  \"consignments\": [\n    {\n      \"pickup_stop\": {\n        \"location\": {\n          \"name\": \"Qargo Ghent\",\n          \"address\": \"Gaston Crommenlaan 4,\",\n          \"postal_code\": \"9000\",\n          \"city\": \"Gent\",\n          \"state\": \"Oost-Vlaanderen\",\n          \"country\": \"BE\",\n          \"description\": \"\"\n        },\n        \"note\": \"\",\n        \"date\": \"2024-08-20\",\n        \"reference_number\": \"\",\n        \"planning_instructions\": \"\",\n        \"email\": \"\",\n        \"phone_number\": \"\",\n        \"mobile_number\": \"\"\n      },\n      \"delivery_stop\": {\n        \"location\": {\n          \"name\": \"Qargo London\",\n          \"address\": \"71-91 Aldwych\",\n          \"postal_code\": \"WC2B 4HN\",\n          \"city\": \"London\",\n          \"country\": \"GB\",\n          \"description\": \"Delivery\"\n        },\n        \"note\": \"Delivery notes\",\n        \"date\": \"2024-08-22\",\n        \"reference_number\": \"\",\n        \"planning_instructions\": \"\",\n        \"email\": \"\",\n        \"phone_number\": \"\",\n        \"mobile_number\": \"\"\n      },\n      \"goods\": [\n        {\n          \"packaged_items\": [\n            {\n              \"adr\": {\n                \"un_number\": \"1956\",\n                \"packaging_type\": \"BOX\",\n                \"emergency_phone_number\": \"+32456789010\",\n                \"technical_name_by_locale\": {\n                  \"de-DE\": \"NEG Stoffname\",\n                  \"en\": \"NEG Substance name\",\n                  \"fr-FR\": \"NEG Nom de la substance\",\n                  \"nl-BE\": \"NEG Stofnaam\"\n                }\n              },\n              \"quantity\": 5,\n              \"total_volume_l\": 100,\n              \"total_weight_kg\": 100,\n              \"description\": \"Dangerous and flammable goods\"\n            }\n          ],\n          \"description\": \"Fuel\",\n          \"quantity\": 1,\n          \"product_name\": \"FUEL\"\n        }\n      ]\n    }\n  ],\n  \"customer_reference_number\": \"QARGO-001\",\n  \"transport_service\": { \"code\": \"HAZARDOUS\" },\n  \"service_level\": { \"code\": \"NEXT_DAY\" }\n}\n```\n\n### Order with pallets and custom barcodes\n\n```json\n{\n  \"order_identifier\": \"PALLETS_WITH_BARCODES_ORDER\",\n  \"operation\": \"CREATE\",\n  \"customer\": { \"name\": \"QARGO\" },\n  \"import_configuration\": { \"code\": \"API\" },\n  \"consignments\": [\n    {\n      \"pickup_stop\": {\n        \"location\": {\n          \"name\": \"Qargo Ghent\",\n          \"address\": \"Gaston Crommenlaan 4,\",\n          \"postal_code\": \"9000\",\n          \"city\": \"Gent\",\n          \"state\": \"Oost-Vlaanderen\",\n          \"country\": \"BE\",\n          \"description\": \"\"\n        },\n        \"note\": \"\",\n        \"date\": \"2024-08-20\",\n        \"reference_number\": \"\",\n        \"planning_instructions\": \"\",\n        \"email\": \"\",\n        \"phone_number\": \"\",\n        \"mobile_number\": \"\"\n      },\n      \"delivery_stop\": {\n        \"location\": {\n          \"name\": \"Qargo London\",\n          \"address\": \"71-91 Aldwych\",\n          \"postal_code\": \"WC2B 4HN\",\n          \"city\": \"London\",\n          \"country\": \"GB\",\n          \"description\": \"Delivery\"\n        },\n        \"note\": \"Delivery notes\",\n        \"date\": \"2024-08-22\",\n        \"reference_number\": \"\",\n        \"planning_instructions\": \"\",\n        \"email\": \"\",\n        \"phone_number\": \"\",\n        \"mobile_number\": \"\"\n      },\n      \"goods\": [\n        {\n          \"quantity\": 1,\n          \"packaging_type\": {\n            \"name\": \"Full Pallet\",\n            \"packaging_size\": { \"code\": \"FP\" }\n          },\n          \"handling_units\": [\n            { \"barcode\": { \"value\": \"01J93R8V517R7133FVCM3ZCJNN\" } }\n          ]\n        },\n        {\n          \"quantity\": 2,\n          \"packaging_type\": {\n            \"name\": \"Half Pallet\",\n            \"packaging_size\": { \"code\": \"HP\" }\n          },\n          \"handling_units\": [\n            { \"barcode\": { \"value\": \"01J93R9024CNTJJPQG8WDP2PVX\" } },\n            { \"barcode\": { \"value\": \"01J93R9PKY3A5C9S6T4VV12C8B\" } }\n          ]\n        }\n      ]\n    }\n  ],\n  \"customer_reference_number\": \"QARGO-0001\",\n  \"transport_service\": { \"code\": \"PALLETS\" },\n  \"service_level\": { \"code\": \"PREMIUM_NEXT_DAY\" }\n}\n```\n\n# Status updates\n\nThe API supports status updates for specific entities. This can either be via an endpoint or webhook.\n\n## Task\n\nThis [endpoint](/docs/api-task/update_task_status_v1_tasks_task__id__update_status_post) allows you to update the status of a task. A task in Qargo is linked to a side effect in an external system.\n\n## Order\n\nYou can change the status of an order via the [webhook](/docs/webhooks-inbound/order-import-webhook) or [endpoint](/docs/api-order/import_order_v1_orders_order_upload_post).\n\n## Stop\n\nThis [webhook](/docs/webhooks-inbound/subcontractor-status-update-webhook) allows you to either update:\n\n1. stops\n2. stop groups\n\nUsing this [webhook](/docs/webhooks-inbound/subcontractor-status-update-webhook) you can provide status updates for stops or stop groups. You can also provide additional information in the payload\nwhich can be mapped to different fields in Qargo.\nStatus update date-time values, including `event_time`, `eta_start`, and `eta_end`, must include a timezone offset such as `Z` or `+02:00`.\n\n## Booking\n\nThis [webhook](/docs/webhooks-inbound/intermodal-booking-status-webhook) allows an external intermodal booking system to report status updates for a booking, including its lifecycle status, execution statuses, and estimated and actual stop times.\nDate-time values must include a timezone offset such as `Z` or `+02:00`.\n\n# Visibility\n\nWe support visibility (sending messages triggered by Qargo system events) in the api as well.\nThese messages can be send out as a [webhook](/docs/webhooks-outbound/operational_visibility_event_webhook_post), or an EDI connection.\n\nFor most endpoints, visibility only trigger on status changes (for example, from stop `IN_PROGRESS` -> `COMPLETED`).\nThere are a few exceptions, these will be indicated in the overview:\n\n- Order level\n  - We send out a visibility event on `ACCEPTED` (order created), `REJECTED` (order skipped) and `COMPLETED` (all stops for order completed).\n- Stop level\n  - We send out a visibility event on `AT_STOP` (arrived at stop), `COMPLETED` (all activities completed for stop).\n- Position level (note: for every telematics update)\n- Trip level\n  - We send a visibility event when a trip changes to `PLANNED` and when it transitions to `COMPLETED`.\n- Resource level\n  - We send an event when a resource is assigned to a certain [trip](/docs/section/concepts/trip).\n# Accounting\n\nThe following section details how to use our api for accounting integrations.\nYou can push/pull accounting information between Qargo and the accounting system.\n\nPlease note that this is not suitable for BI/analytics purposes.\nWe offer a SQL based data warehouse connector to support this use case.\n\n## Synchronize invoices/credit notes\n\nThe flow for sales/purchase invoices and sales credit notes is the same, with a different payload.\nWe will show an example of syncing a sales invoices below\n\nWe use a task oriented approach to indicate which invoice to sync (post in the accounting software).\nThe implementer should take the following steps:\n\n- Fetch a list of available tasks (tasks in a TODO state)\n- For each available task:\n- Fetch the payload in the task details\n- Sync the data to the accounting system.\n- Report the status back, this result can be success or failure.\n\n![Sync invoice/credit note flow](https://api.qargo.com/docs/static/sync_invoice_flow.svg)\n\nIt is allowed to only process a subset of the available tasks and process the remaining invoices later.\n\n### Example\n\nFetch the Invoice/Credit notes to sync using [sync tasks endpoint](/docs/api-accounting/list_invoices_credit_notes_to_sync_v1_accounting_sync_tasks_get)\n\n```\ncurl https://api.qargo.com/v1/accounting/sync-tasks -H 'Content-type: application/json' -H 'Authorization: Bearer *access_token*'\n```\n\nResponse:\n\n```json\n{ \"tasks\": [{ \"id\": \"*id_of_first_task*\" }] }\n```\n\nNote that as long as an endpoint is not marked as completed/failed, it will still show up as an available POST task.\n\nFetch the first payload:\n\n<pre>\ncurl https://api.qargo.com/v1/accounting/sync-tasks/*id_of_first_task* -H 'Content-type: application/json' -H 'Authorization: Bearer *access_token*'\n</pre>\n\nResponse:\n\n<pre>\n{\"id\": \"<id_of_first_task>\", \"status\": \"TODO\", \"task_type\": \"POST_INVOICE\", \"payload\": {....}}\n</pre>\n\n<!--\nFetch the invoice document (when required).\n\n```\ncurl https://api.qargo.com/v1/documents/document/*id_of_document*/download -H 'Content-type: application/json' -H 'Authorization: Bearer *access_token*' -O\n```\n\nResponse:\n\n```\n* Document content *\n```\n\nComplete the first task:\n\n```\ncurl -X POST https://api.qargo.com/v1/accounting/sync-tasks/*id_of_first_task*/update-status -H 'Content-type: application/json' -H 'Authorization: Bearer *access_token*' -d '{\"status\": \"COMPLETED\"}'\n```\n\nResponse:\n\n```json\n{\"id\": \"<id_of_first_task>\", \"status\": \"COMPLETED\", \"task_type\": \"POST_INVOICE\"}\n```\n\n-->\n\n## Fetch updated customer information\n\n### Example\n\n```\ncurl https://api.qargo.com/v1/company/*id_of_customer* -H 'Content-type: application/json' -H 'Authorization: Bearer *access_token*'\n```\n\nResponse:\n\n```\n{\"id\": \"<id_of_customer>\", ...}\n```\n\nNote: since we embed the customer/supplier company in the invoice payload, it is possible to synchronise these companies as part of the invoice posting flow.\n\n## Synchronize blocked status of customer\n\n### Example\n\nUpdate the customer blocked status:\n\n```\ncurl -X POST https://api.qargo.com/v1/company/*id_of_customer* -H 'Content-type: application/json' -H 'Authorization: Bearer *access_token*' -d  '{\"is_blocked\": true}'\n```\n\nResponse:\n\n```\n{\"id\": \"<id_of_customer>\", \"is_blocked\": true, ....}\n```\n\n## Creating contacts for a customer or subcontractor\n\nYou can create a contact for a customer or subcontractor by providing a `contacts` list in the payload.\n\n### Example\n\n```\ncurl -X PATCH https://api.qargo.com/v1/company/*id_of_customer* -H 'Content-type: application/json' -H 'Authorization: Bearer *access_token*' -d  '{\"contacts\":[{\"name\":\"Contact name\",\"note\":\"Notes on the contact\",\"phone_number\":\"+32456789016\",\"email\":\"hello@qargo.com\",\"roles\":[\"BILLING\",\"OPERATIONS\"]}]}'\n```\n\n## Updating contacts for a customer or subcontractor\n\nTo update a contact, you need to provide the `id` of the contact you want to update in the payload.\n\n### Example\n\n```\ncurl -X PATCH https://api.qargo.com/v1/company/*id_of_customer* -H 'Content-type: application/json' -H 'Authorization: Bearer *access_token*' -d  '{\"id\": \"3ba86d22-0183-4575-804d-60e0a6fa2f74\", \"contacts\":[{\"name\":\"Contact name\",\"note\":\"Notes on the contact\",\"phone_number\":\"+32456789016\",\"email\":\"hello@qargo.com\",\"roles\":[\"BILLING\",\"OPERATIONS\"]}]}'\n```\n\n## Archiving a contact for a customer or subcontractor\n\nTo archive a contact, you need to provide the `is_archived` field in the payload along with the `id` of the contact you want to archive.\n\n### Example\n\n```\ncurl -X PATCH https://api.qargo.com/v1/company/*id_of_customer* -H 'Content-type: application/json' -H 'Authorization: Bearer *access_token*' -d  '{\"is_archived\": true, \"id\": \"3ba86d22-0183-4575-804d-60e0a6fa2f74\", \"contacts\":[{\"name\":\"Contact name\",\"note\":\"Notes on the contact\",\"phone_number\":\"+32456789016\",\"email\":\"hello@qargo.com\",\"roles\":[\"BILLING\",\"OPERATIONS\"]}]}'\n```\n\n# Resources\n\n## Resource groups\n\nResource groups represent the depot or site a resource (vehicle, driver, trailer) is allocated to, and they determine where the resource appears on the planning board. Use the API to keep group allocations in sync when resources move between sites — for example from a telematics or fleet management system.\n\n### Looking up resource groups\n\nResource group ids are specific to your environment. Use the lookup endpoint to find the id of the group you want to allocate to. Archived resource groups are not included.\n\n```json\nGET /resource_groups\n\n{\n  \"items\": [\n    { \"id\": \"7f0c1e2a-1111-4a6e-9c2b-3d5f8e7a9b01\", \"name\": \"Oswestry\", \"code\": \"OSW\" },\n    { \"id\": \"a4b8d990-2222-4c1f-8e3a-6b9d0c4e5f02\", \"name\": \"Leeds\", \"code\": \"LDS\" }\n  ],\n  \"next_cursor\": null\n}\n```\n\nLookups by name or code are not supported, since names and codes are not guaranteed to be unique.\n\n### Reading a resource's groups\n\nAll resource read endpoints return `resource_groups`: the groups the resource is currently allocated to. This is a list — a resource can be allocated to more than one group at the same time (for example through rotating schedules). For most resources it contains a single element; it is empty when the resource is not in any group.\n\n```json\nGET /resource/{resource_id}\n\n{\n  \"id\": \"3f9e6b1c-3333-4d2e-b1a4-7c8f9e0a1b03\",\n  \"name\": \"Truck 142\",\n  \"resource_groups\": [\n    { \"id\": \"7f0c1e2a-1111-4a6e-9c2b-3d5f8e7a9b01\", \"name\": \"Oswestry\", \"code\": \"OSW\" }\n  ]\n}\n```\n\n### Updating a resource's group\n\nSet the group with a PATCH on the resource, referencing the group by id. One resource per call — there is no bulk update.\n\n```json\nPATCH /resource/{resource_id}\n{ \"resource_group\": { \"id\": \"a4b8d990-2222-4c1f-8e3a-6b9d0c4e5f02\" } }\n```\n\nSend an explicit `null` to remove the resource from its group. Omitting the field leaves the allocation unchanged.\n\n```json\nPATCH /resource/{resource_id}\n{ \"resource_group\": null }\n```\n\nNote the asymmetry: you set a single group, but read a list. The PATCH manages the resource's own (fixed) allocation; allocations coming from combinations of multiple resources or from rotating schedules are not affected by it and stay managed in the TMS UI.\n\n### Errors\n\n```json\nHTTP 400\n{ \"message\": \"Resource group with id a4b8d990-2222-4c1f-8e3a-6b9d0c4e5f02 not found\" }\n```\n\nReturned when the referenced group does not exist in your environment, or is archived.\n\nChanging a group does not trigger notifications in Qargo and does not adjust planning rules or auto-assign logic tied to the previous group.\n\n## Extras\n\nResources can be associated with stop extras (e.g. ADR, taillift, temperature control) to indicate which extras the resource is compatible with. Extras are specific to your environment — use the TMS UI or ask your Qargo contact to find the codes available.\n\n### Setting extras on create\n\nInclude `extras` in the POST body to set extras when creating a resource.\n\n```json\nPOST /resource\n{\n  \"resource_type\": \"TRACTOR\",\n  \"name\": \"Truck 01\",\n  \"extras\": [\n    { \"code\": \"ADR\" },\n    { \"code\": \"TAIL\" }\n  ]\n}\n```\n\n### Response (all read endpoints)\n\n```json\n{\n  \"extras\": [\n    { \"id\": \"uuid-1\", \"code\": \"ADR\", \"name\": \"ADR Transport\" },\n    { \"id\": \"uuid-2\", \"code\": \"TAIL\", \"name\": \"Taillift\" }\n  ]\n}\n```\n\n### Updating extras\n\nProviding `extras` replaces the entire list. Omitting the field leaves existing extras untouched. Send an empty list to clear all extras.\n\n```json\nPATCH /resource/{resource_id}\n{ \"extras\": [{ \"code\": \"TAIL\" }] }\n```\n\n### Error — duplicate code\n\nIf a code matches more than one extra in the tenant, the API returns an error.\n\n```json\nHTTP 400\n{ \"message\": \"Multiple extras found with code 'TAIL'. Please ensure extra codes are unique, or contact support.\" }\n```\n\n## Unavailabilities\n\n### Creating a unavailability\n\nCreating an unavailability is always for a single resource. Currently no bulk unavailability creation is supported.\n\n```json\n{\n  \"reason\": \"DRIVER_HOLIDAY\",\n  \"start_time\": \"2025-01-08T00:00:00+00:00\",\n  \"end_time\": \"2025-01-12T00:00:00+00:00\",\n  \"description\": \"HR reference HR00001\",\n  \"external_id\": \"YOUR_REFERENCE_00001\"\n}\n```\n\n### Updating an unavailability\n\nUpdating an unavailability is always for a single resource. Currently no bulk unavailability updates are supported.\n\n```json\n{\n  \"reason\": \"DRIVER_HOLIDAY\",\n  \"start_time\": \"2025-01-09T00:00:00+00:00\",\n  \"end_time\": \"2025-01-12T00:00:00+00:00\",\n  \"description\": \"HR reference HR00002, correction 1 day\",\n  \"external_id\": \"YOUR_REFERENCE_00001\"\n}\n```\n\n### Deleting an unavailability\n\nDeleting a unavailability will remove the unavailability from the system. This is not reversable.\n# E-invoicing\n\n> E-invoicing refers to the automated, digital exchange of structured invoice data between businesses (e.g., suppliers and buyers) in a standardized format.\n\nWe support receiving purchase invoices and credit notes in multiple formats:\n\n- **JSON** — Qargo's own structured purchase invoice/credit note schema\n- **XML (UBL)** — Peppol-compliant UBL documents\n- **Multipart** — JSON data combined with file attachments (PDF, XML, etc.)\n- **Custom formats** — CSV, EDIFACT, fixed-width, or other proprietary formats via the Qargo integration framework\n\nAttachments (e.g. the invoice PDF, CMR documents) can be included either via the `attachments[].document` object in JSON (with base64-encoded content), or as additional parts in a multipart upload.\n\n## Peppol\n\nFor more information on Peppol E-invoicing, see https://help.qargo.com/en/articles/304774-invoices-peppol-in-qargo.\n\n## Workflows\n\n### Importing E-invoices into Qargo via webhook\n\nThis [endpoint](/docs/use-case-e-invoicing/e-invoicing-webhook) allows importing e-invoices into Qargo. The e-invoice can either be a purchase invoice or a purchase credit note. See the endpoint documentation for detailed format examples and attachment handling.\n\n# Question paths and answers\n\nQuestion paths are a configuration mechanism that maps fields in incoming data to specific fields, documents or actions in Qargo. A `question_answers` dict can be included on updates in two webhooks:\n\n- [Status update](/docs/webhooks-inbound/subcontractor-status-update-webhook) — on stop or stop group updates\n- [Partial order update](/docs/webhooks-inbound/partial-order-update) — on order, consignment, stop, good, or handling unit updates\n\nThe keys of this dict correspond to question paths configured on an integration; the values are the answers.\n\n**Status update example**\n\n```json\n{\n  \"updates\": [\n    {\n      \"event_time\": \"2024-08-20T10:00:00Z\",\n      \"stop\": {\n        \"id\": \"a2a84715-0027-49af-ad30-494c0ccf75cc\",\n        \"status\": \"COMPLETED\",\n        \"question_answers\": {\n          \"trailer_number\": \"VB-123-AB\"\n        }\n      }\n    }\n  ]\n}\n```\n\n**Partial order update example**\n\n```json\n{\n  \"updates\": [\n    {\n      \"match\": {\n        \"matches_all\": [\n          {\n            \"order\": {\n              \"customer_reference_number\": { \"matches_any\": [\"T1234393\"] }\n            }\n          }\n        ]\n      },\n      \"consignment\": {\n        \"updates\": [\n          {\n            \"question_answers\": {\n              \"consignee_signature\": {\n                \"embedded_document\": {\n                  \"content\": \"IkhlbGxvLCB3b3JsZC4gSGVsbG8sIHdvcmxkLiBIZWxsbywgd29ybGQuIg==\",\n                  \"content_type\": \"image/svg+xml\",\n                  \"filename\": \"a_file_name.svg\"\n                }\n              }\n            },\n            \"good\": {\n              \"updates\": [\n                {\n                  \"handling_unit\": {\n                    \"updates\": [\n                      {\n                        \"match\": {\n                          \"matches_all\": [\n                            {\n                              \"handling_unit\": {\n                                \"barcode\": { \"matches_any\": [\"ABC123\"] }\n                              }\n                            }\n                          ]\n                        },\n                        \"question_answers\": {\n                          \"scan_barcode\": [\n                            {\n                              \"timestamp\": \"2024-08-20T10:00:00Z\",\n                              \"status\": \"DELIVERED\",\n                              \"stop_location_code\": \"DEPOT-001\",\n                              \"stop_match\": {\n                                \"location\": {\n                                  \"postal_code\": { \"matches_any\": [\"NW1 2AB\"] }\n                                }\n                              }\n                            }\n                          ]\n                        }\n                      }\n                    ]\n                  }\n                }\n              ]\n            }\n          }\n        ]\n      }\n    }\n  ]\n}\n```\n\n## Document sync via question_paths\n\nAdds a document to its relevant subject (e.g. POD/CMR -> consignment). The document can either be embedded or referenced.\nExactly one of `remote_document` or `embedded_document` must be defined per document object.\n\n**Answer format**: JSON array of document objects.\n\n```json\n[\n  {\n    \"remote_document\": {\n      \"upload_id\": \"6f223c71-5758-4a31-b2e8-84ba91a90dd1\"\n    }\n  }\n]\n```\n\n```json\n[\n  {\n    \"embedded_document\": {\n      \"content\": \"IkhlbGxvLCB3b3JsZC4gSGVsbG8sIHdvcmxkLiBIZWxsbywgd29ybGQuIg==\",\n      \"content_type\": \"image/png\",\n      \"filename\": \"a_file_name.png\"\n    }\n  }\n]\n```\n\n### Replacing a document\n\nInclude an `external_id` to give the document a stable identity in your own system. Sending a document again under an external id that was used before on the same subject replaces the earlier one: the new document is added and the one it supersedes is removed. This is how a regenerated document (e.g. a pallet label reprinted after the pallet count changed) is kept as a single document instead of accumulating versions.\n\nThe external id must identify a single document. It is scoped to the subject the document is attached to, so the same value can be reused across orders, consignments or stops, but reusing one value for two documents on the same subject (e.g. a proof of delivery and a CMR) means the second one replaces the first.\n\n```json\n[\n  {\n    \"external_id\": \"LABEL-4471\",\n    \"embedded_document\": {\n      \"content\": \"IkhlbGxvLCB3b3JsZC4gSGVsbG8sIHdvcmxkLiBIZWxsbywgd29ybGQuIg==\",\n      \"content_type\": \"image/png\",\n      \"filename\": \"pallet_label.png\"\n    }\n  }\n]\n```\n\n| Field               | Type   | Required | Description                                                     |\n| ------------------- | ------ | -------- | --------------------------------------------------------------- |\n| `remote_document`   | object | No       | Object with upload id of uploaded document                      |\n| `embedded_document` | object | No       | Document info with base64 encoded document                      |\n| `external_id`       | string | No       | Identifier of the document in your system, used to replace it   |\n\n#### `remote_document` fields\n\n| Field       | Type | Description                                                                  |\n| ----------- | ---- | ---------------------------------------------------------------------------- |\n| `upload_id` | UUID | Upload id of document, received from the `/document/upload_content` endpoint |\n\n#### `embedded_document` fields\n\n| Field          | Type   | Description                               |\n| -------------- | ------ | ----------------------------------------- |\n| `content`      | string | Base64 encoded document                   |\n| `content_type` | string | The content type of the embedded document |\n| `filename`     | string | The filename of the embedded document     |\n\n## Actions\n\nApart from updating fields and documents, question paths can be configured to trigger one of the following actions.\n\n### `assign_resource`\n\nAssigns a resource (trailer, container, or full trailer) to an order or trip based on a plain-text identifier.\nIf no matching resource is found the answer is silently ignored.\n\n**Answer format**: plain string — the resource's name, code, licence plate, or container number.\n\n```\nVB-123-AB\n```\n\nMatching strips all non-alphanumeric characters and is case-insensitive, so `VB-123-AB`, `VB 123 AB`, and `VB123AB` all resolve to the same resource.\n\n### `scan_barcode`\n\nRecords a barcode scan event on a handling unit. An optional stop match is provided, which if matched will record which stop the scan is related to alongside the scan. If the stop is not matched the scan will still succeed, but the stop will not be recorded.\n\n**Answer format**: JSON array of scan objects.\n\n```json\n[\n  {\n    \"timestamp\": \"2024-08-20T10:00:00Z\",\n    \"status\": \"SCANNED_IN\",\n    \"stop_location_code\": \"DEPOT-001\",\n    \"stop_match\": {\n      \"location\": {\n        \"postal_code\": { \"matches_any\": [\"NW1 2AB\"] }\n      }\n    }\n  }\n]\n```\n\n| Field                | Type              | Required | Description                                                                                                                 |\n| -------------------- | ----------------- | -------- | --------------------------------------------------------------------------------------------------------------------------- |\n| `timestamp`          | ISO 8601 datetime | Yes      | Time of the scan event                                                                                                      |\n| `status`             | string            | No       | Scan status (see below)                                                                                                     |\n| `barcode`            | string            | No       | Barcode value; used to identify the handling unit. Optional as the unit will have been matched in the partial order update. |\n| `stop_match`         | object            | No       | Criteria for matching the scan to a specific stop on the trip (see below)                                                   |\n| `stop_location_code` | string            | No       | Location identifier code                                                                                                    |\n| `description`        | string            | No       | Free-text description                                                                                                       |\n\n#### `stop_match` fields\n\n| Field              | Type   | Description                                                                    |\n| ------------------ | ------ | ------------------------------------------------------------------------------ |\n| `stop_type`        | string | Type of stop to match: `PICKUP`, `DELIVERY`, `DEPOT_UNLOAD` or `DEPOT_LOAD`     |\n| `id`               | object | Match by stop ID: `{ \"matches_any\": [\"<id>\"] }`                                |\n| `reference_number` | object | Match by stop reference number: `{ \"matches_any\": [\"<reference>\"] }`           |\n| `location`         | object | Match by the stop's location (see below)                                       |\n| `leg`              | object | Match by the leg (stage) the stop bounds (see below)                           |\n\nA depot is modelled as two stops: the goods are unloaded off the inbound leg (`DEPOT_UNLOAD`) and\nlater loaded onto the outbound leg (`DEPOT_LOAD`). Direct consignments have no depot stops, so\nneither depot stop type matches anything there — use `PICKUP` / `DELIVERY` instead.\n\nFrom three legs onwards each depot stop type occurs more than once per consignment, so `stop_type`\nalone is ambiguous and `leg` must be supplied as well. Ambiguous matches are not resolved by\nguessing: the scan is left unlinked (or the update rejected) instead.\n\n| Scan                          | `stop_type`    | `leg.leg_type`                |\n| ----------------------------- | -------------- | ----------------------------- |\n| `COLLECTION_DEPOT_SCANNED_IN` | `DEPOT_UNLOAD` | `PICKUP`                      |\n| `COLLECTION_DEPOT_SCANNED_OUT`| `DEPOT_LOAD`   | `TRANSFER` (2 legs: `DELIVERY`)|\n| `DELIVERY_DEPOT_SCANNED_IN`   | `DEPOT_UNLOAD` | `TRANSFER` (2 legs: n/a)      |\n| `DELIVERY_DEPOT_SCANNED_OUT`  | `DEPOT_LOAD`   | `DELIVERY`                    |\n\n#### `stop_match.leg` fields\n\n| Field      | Type   | Description                                                                     |\n| ---------- | ------ | ------------------------------------------------------------------------------- |\n| `leg_type` | string | Type of leg the stop bounds: `PICKUP`, `TRANSFER`, `DELIVERY`, `DIRECT`, `EMPTY` |\n\n#### `stop_match.location` fields\n\n| Field          | Type   | Description                                                    |\n| -------------- | ------ | -------------------------------------------------------------- |\n| `id`           | object | Match by location ID: `{ \"matches_any\": [\"<id>\"] }`            |\n| `name`         | object | Match by location name: `{ \"matches_any\": [\"<name>\"] }`        |\n| `postal_code`  | object | Match by postal code: `{ \"matches_any\": [\"<postal_code>\"] }`   |\n| `country_code` | object | Match by country code: `{ \"matches_any\": [\"<country_code>\"] }` |\n\nAvailable status values:\n\n| Value         | Description                                                         |\n| ------------- | ------------------------------------------------------------------- |\n| `SCANNED_IN`  | Handling unit has been scanned in at a pickup stop or at a depot    |\n| `STORED`      | Handling unit is in storage at a depot                              |\n| `SCANNED_OUT` | Handling unit has been scanned out of a depot or at a delivery stop |\n\n# MCP\n\nThe Qargo MCP server lets an AI assistant call the Qargo API on behalf of a signed-in user, using the Model Context Protocol.\n\n## What it is\n\nMCP is an open standard for connecting AI assistants to external systems. The Qargo MCP server implements it as a thin layer over this API. It exposes no separate data model, and every call it makes is an ordinary API call, subject to the same [authentication](/docs/section/authentication) and [rate limits](/docs/section/rate-limits) as any other.\n\nUse it when an assistant should answer questions about live tenant data, or perform routine changes under human supervision. Use the REST API directly for integrations, scheduled jobs, and anything needing deterministic behaviour.\n\n## Endpoint\n\nThe server is at `https://mcp.qargo.com/mcp`, and appears in the client as **Qargo**.\n\nTransport is MCP over streamable HTTP. Server-sent events are not supported.\n\n## Not the same as the documentation MCP\n\nThis site also publishes a documentation MCP server, offered through the **Connect to Cursor** and **Connect to VS Code** buttons at the top of each page. That server reads this API reference and nothing else. It has no access to tenant data and no relationship to `mcp.qargo.com`.\n\n## Prerequisites\n\nThree conditions must be met before a connection succeeds.\n\n| Requirement | Scope | Set by |\n| --- | --- | --- |\n| Qargo Intelligence | Tenant | Qargo |\n| External API access | Tenant | Qargo |\n| MCP access, read-only or read and write | Individual user, per tenant | Qargo |\n\nMCP access defaults to disabled for every user. Enabling Qargo Intelligence on a tenant grants it to nobody.\n\nFor access requests, please contact us at [integrations@qargo.com](mailto:integrations@qargo.com).\n\n## Connecting\n\nAuthorisation uses OAuth 2.1 with PKCE and dynamic client registration, so a compliant client needs no Qargo-specific configuration.\n\n### Flow\n\nPoint the client at the endpoint with no credentials. It discovers the authorisation server, registers itself, and opens a browser. The user signs in to Qargo, the browser returns an authorisation code, and the client exchanges it for tokens.\n\n```json\n{\n  \"mcpServers\": {\n    \"qargo\": {\n      \"type\": \"http\",\n      \"url\": \"https://mcp.qargo.com/mcp\"\n    }\n  }\n}\n```\n\nClients that expose a connector UI rather than a config file need only the URL.\n\n### Authorisation server details\n\nMost clients discover these automatically. They are documented for clients that ask for them explicitly.\n\n| Setting | Value |\n| --- | --- |\n| Discovery | `https://oauth.qargo.com/.well-known/oauth-authorization-server` |\n| Authorization endpoint | `https://oauth.qargo.com/authorize` |\n| Token endpoint | `https://oauth.qargo.com/token` |\n| PKCE | Required. `S256` only, `plain` is rejected |\n| Client authentication | None. Public clients only |\n| Client registration | Dynamic only, per RFC 7591 |\n| Scopes | Not used. The `scope` parameter is ignored |\n| Refresh | Supported. `grant_type=refresh_token` |\n\nClients requiring a pre-issued `client_id` and `client_secret` cannot connect, because Qargo issues neither. This rules out platforms whose configuration form demands static client credentials, including Gemini Enterprise.\n\n### Token model\n\nThe token the client holds identifies the user but carries no tenant claims. It can do nothing except list the tenants that user can reach. Every tenant-scoped call triggers a server-side exchange for a token carrying the user's Qargo role in that tenant.\n\n| Token | Lifetime | Notes |\n| --- | --- | --- |\n| Client token | 1 hour | Refreshable |\n| Tenant token | 1 hour | Minted per tenant on demand |\n\nAuthorisation is re-checked on every call and never cached, so revoking a user's MCP access takes effect on their next request.\n\n### Sessions\n\nSessions expire and require the user to sign in again, in practice about once a day. Expect re-authentication rather than treating it as an error.\n\nClients must send a stable `Mcp-Session-Id` header across a conversation. Production write approval is keyed on it, so a client that omits it or rotates it per request cannot complete a write. See [limits and safeguards](/docs/section/mcp/limits-and-safeguards) for the approval flow.\n\n## Client setup\n\nAny MCP client supporting streamable HTTP and dynamic client registration can connect. Configuration for the clients Qargo tests against follows.\n\n### Claude Desktop and claude.ai\n\nAdd a custom connector under `Settings > Connectors` with the address `https://mcp.qargo.com/mcp`. Authorisation opens in a browser on first use.\n\n### Claude Code\n\n```\nclaude mcp add --transport http qargo https://mcp.qargo.com/mcp\n```\n\nThen run `/mcp` and select `qargo` to authenticate. Tokens are stored per project unless the server is registered globally.\n\n### ChatGPT\n\nCustom MCP connectors sit behind developer mode, on paid plans only. In Business, Enterprise and Education workspaces a workspace owner creates and publishes the app, and members cannot add it themselves. On Plus and Pro, an individual user adds it directly. Either way each user authenticates separately, so each gets their own Qargo permissions.\n\nEnter the endpoint and select OAuth. Leave client ID and secret empty, since dynamic registration covers them.\n\n### Gemini\n\nGemini Enterprise is not supported. It requires a static `client_id` and `client_secret` in its custom MCP server configuration, and it requires a scope list. Qargo issues no client credentials and ignores the `scope` parameter. The consumer Gemini app has no custom MCP server option at all.\n\nGemini CLI can connect, because it supports dynamic discovery:\n\n```json\n{\n  \"mcpServers\": {\n    \"qargo\": {\n      \"httpUrl\": \"https://mcp.qargo.com/mcp\"\n    }\n  }\n}\n```\n\nRun `/mcp auth qargo` to authenticate. OAuth requires a local browser and does not work over SSH.\n\n### Other clients\n\nA client works if it supports streamable HTTP, PKCE with `S256`, dynamic client registration, and a stable `Mcp-Session-Id`. Test with `tools/list` before assuming write support.\n\n## Tools and access levels\n\nThe server exposes six generic tools rather than one tool per endpoint. Assistants discover operations at runtime from the OpenAPI description.\n\n### Tools\n\n| Tool | Purpose |\n| --- | --- |\n| `list_tenants` | Lists the tenants the caller can access, with their role in each. Available even with no access granted. |\n| `get_tenant_details` | Returns identity, locale and billing address details for one tenant. |\n| `external_api_discover` | Lists available operations, filterable by domain, method or free text. |\n| `external_api_schema` | Returns the full request and response schema for one `operationId`, with references resolved inline. |\n| `external_api_call` | Executes an operation by `operationId`, with path parameters, query parameters and a JSON body. |\n| `request_upload` | Returns a presigned URL and a `file_id` for a file to be attached to a later call. |\n\nEvery tenant-scoped tool accepts `tenant_id` or `tenant_slug`. Provide exactly one.\n\n### Tool annotations\n\nEvery tool carries MCP annotations, which clients use to decide when to prompt the user.\n\n| Annotation | Applied to |\n| --- | --- |\n| `readOnlyHint: true` | All read operations. Most clients execute these without asking. |\n| `destructiveHint: false` | Ordinary writes. Qargo write approval still applies. |\n| `destructiveHint: true` | `external_api_call` and integration actions. |\n\n### Operation allowlist\n\n`external_api_discover` and `external_api_call` are restricted to an allowlist of approved operations. Anything outside it is neither listed nor callable.\n\n| Domain | Operations |\n| --- | --- |\n| Accounting | 33 |\n| Resource | 17 |\n| Company | 14 |\n| Order | 7 |\n| Task | 3 |\n| Trip | 3 |\n| Document | 2 |\n| Identity | 1 |\n\nDeprecated endpoints, webhook receivers and dispatch, authentication token generation, and webhook test utilities are excluded by design.\n\n### Access levels\n\nAccess is a server-side property of the user, not an OAuth scope. Clients request nothing and cannot influence it.\n\n| Level | Grants |\n| --- | --- |\n| Disabled | No tools. The default for every user. |\n| Read-only | Every read-only operation. |\n| Read and write | Reads, plus every write and destructive operation. |\n\nWrite access alone is not offered. `external_api_call` resolves each operation through a read-scoped client first, so a write-only user could not call it.\n\n### Errors\n\n| Class | What the assistant receives |\n| --- | --- |\n| Tool error | The specific message plus a hint naming the next tool to call. Covers bad input, missing records, wrong tenant and insufficient access. |\n| Write protection error | An approval URL and instructions to retry after approval. |\n| Internal error | A generic message only. Details are not exposed. |\n\nA `404` from the underlying API is returned as information, not as a failure.\n\n## Limits and safeguards\n\nCalls made through MCP are ordinary API calls, so the [rate limits](/docs/section/rate-limits) apply unchanged. Additional constraints exist because the caller is an assistant rather than an application.\n\n### Production write protection\n\nWriting to a production tenant requires explicit human approval before the first change in a session. The tool returns an approval URL:\n\n```\nhttps://app.qargo.com/<tenant_slug>/mcp/write-protection?sessionId=<id>&ttl=<minutes>\n```\n\nThe user opens it, approves, and asks the assistant to retry. Approval is scoped to the user, the tenant and the assistant session together, so a new session requires a new approval.\n\nTwo conditions must hold. The user must open the link in a browser already signed in to `app.qargo.com`, and the client must send a stable `Mcp-Session-Id`. If the approval store is unavailable, production writes are refused. Reads are unaffected.\n\n### Rate limits\n\nLimits are enforced per tenant on the credential, not per user, and are shared with any other API traffic that tenant generates. Exceeding them returns `429 Too Many Requests` with a `Retry-After` header. See [rate limits](/docs/section/rate-limits) for current figures.\n\n### Response size and pagination\n\n| Constraint | Behaviour |\n| --- | --- |\n| List results | Capped at 50 records per call, with a pagination hint in the response |\n| Response size | Payloads above the response budget are written to temporary storage and returned as a signed URL rather than inline |\n| File uploads | Two-step through `request_upload`, 20 MB maximum. Tools never receive file bytes directly. |\n\n### What is out of scope\n\n- Aggregated reporting, analytics and dashboard generation. Use the API directly, or the SQL based data warehouse connector.\n- Tenant configuration, feature flags and integration setup.\n- Any operation absent from the allowlist.\n\n### Operational guidance\n\nAssistants are non-deterministic. Treat MCP as a supervised interface, not an unattended one:\n\n- Grant read-only by default, and read and write only where a change workflow requires it.\n- Review changes before approving a write session, particularly any change affecting more than one record.\n- Prefer the REST API for anything scheduled, repeated or business critical.\n\nFor any questions about these limits, please contact us at [integrations@qargo.com](mailto:integrations@qargo.com).\n\n# Changelog\n\nRecent additions and changes to the API, newest first.\n\n## 2026-09-04\n\n**API**\n\n- **Added:** Good schemas gain an optional `hs_codes` object on order create and order read, carrying `count`: the number of HS codes for the good, used for customs rate calculation.\n  - _Affects:_ [Order](/docs/api-order)\n\n**Webhooks**\n\n- **Added:** `GoodData` and `GoodUpdateData` gain an optional `hs_codes` object on the partial order update webhook (creating and updating a good), carrying `count`: the number of HS codes for the good, used for customs rate calculation.\n  - _Affects:_ [Order](/docs/use-case-order)\n  - _Endpoints:_ [POST /v1/webhook/partial-order-update](/docs/webhooks-inbound/partial-order-update)\n\n**Outgoing data**\n\n- **Added:** Goods in outbound order payloads — operational visibility, fleet and subcontractor dispatch, intermodal and location bookings — gain an optional `hs_codes` object, carrying `count`: the number of HS codes for the good. The field is omitted when not set on the good.\n  - _Affects:_ [Customer portal](/docs/use-case-customer-portal), [Fleet dispatch](/docs/use-case-fleet-dispatch), [Intermodal](/docs/use-case-intermodal-partner), [Location booking](/docs/use-case-location-booking), [Order](/docs/use-case-order), [Subcontractor dispatch](/docs/use-case-subcontractor-dispatch), [Visibility](/docs/use-case-visibility)\n\n## 2026-09-01\n\n**API**\n\n- **Added:** Packaged items gain an optional `waste` object and goods gain `waste_category`, for cargo classified under the European Waste Catalogue. `waste` carries the `ewc` code with its hazard flag and localized description, plus `consistency`, `persistent_organic_pollutants`, `processing_operation` and `emitter_type`. Available on order upload, partial order update and in order responses.\n  - _Affects:_ [Order](/docs/api-order)\n\n## 2026-08-28\n\n**API**\n\n- **Added:** `BarcodeSource` gains `APC` and `PALLETLINE_OPTIMA`, identifying barcodes originating from the APC and Palletline Optima network integrations. Treat the barcode source as an open set and ignore values you do not recognise rather than rejecting the order.\n  - _Affects:_ [Order](/docs/api-order)\n\n## 2026-08-26\n\n**API**\n\n- **Added:** Stop extras accept a `custom_fields` object on order upload, matching order- and good-level extras.\n  - _Affects:_ [Order](/docs/api-order)\n- **Added:** `Consignment.tracking_link` is now returned on order responses: the public tracking page URL for each consignment. It is `null` when the consignment has no tracking link, for example when the tracking link integration is not enabled on the tenant or the link has been revoked.\n  - _Affects:_ [Order](/docs/api-order)\n  - _Endpoints:_ [GET /v1/orders/order/{order_id}](/docs/api-order/get_order_details_v1_orders_order__order_id__get), [GET /v1/orders/order/{order_id}/status](/docs/api-order/order_status_v1_orders_order__order_id__status_get)\n\n**Webhooks**\n\n- **Added:** `TrackingUpdateData` gains an optional `voltage` object, carrying `external_power_supply_voltage_mv`: the external supply voltage of a unit in millivolts. Report the voltage of the external power line rather than the internal battery, so that a unit running on its own battery reports a value at or near zero. This lets Qargo derive whether a temperature-controlled unit is plugged in to external power.\n  - _Affects:_ [Tracking](/docs/use-case-tracking)\n  - _Endpoints:_ [POST /v1/webhook/tracking-update](/docs/webhooks-inbound/tracking-update)\n\n## 2026-08-24\n\n**Webhooks**\n\n- **Added:** `PackagedItemInput.barcodes` accepts a list of barcode strings on packaged items, matching the existing `packaged_items[].barcodes` field on order upload. Previously the partial order update dropped the field.\n  - _Affects:_ [Order](/docs/use-case-order)\n  - _Endpoints:_ [POST /v1/webhook/partial-order-update](/docs/webhooks-inbound/partial-order-update)\n\n## 2026-08-19\n\n**API**\n\n- **Added:** `PaymentTermCode` gains `END_OF_MONTH_0_NET_20`, for a payment term of end of this month plus 20 days.\n  - _Affects:_ [Accounting](/docs/api-accounting), [Company](/docs/api-company), [Order](/docs/api-order), [Task](/docs/api-task), [Trip](/docs/api-trip)\n\n**Webhooks**\n\n- **Added:** Stop matching now reaches depot stops. `StopMatch.stop_type` accepts `DEPOT_UNLOAD` and `DEPOT_LOAD`, and the new `StopMatch.leg` object narrows a match to the leg a stop bounds via `leg_type` (`PICKUP`, `TRANSFER`, `DELIVERY`, `DIRECT`, `EMPTY`). From three legs onwards each depot stop type occurs more than once per consignment, so `leg` must be supplied alongside `stop_type`; ambiguous matches are left unresolved rather than guessed.\n  - _Affects:_ [Fleet dispatch](/docs/use-case-fleet-dispatch), [Order](/docs/use-case-order), [Subcontractor dispatch](/docs/use-case-subcontractor-dispatch)\n  - _Endpoints:_ [POST /v1/webhook/fleet-status-update](/docs/webhooks-inbound/fleet-status-update-webhook), [POST /v1/webhook/partial-order-update](/docs/webhooks-inbound/partial-order-update), [POST /v1/webhook/subco-status-update](/docs/webhooks-inbound/subcontractor-status-update-webhook)\n\n## 2026-08-14\n\n**API**\n\n- **Fixed:** The `/me` response now includes `active_tenant_slug` for CUSTOMER-role tokens, matching other API roles.\n  - _Affects:_ [System](/docs/system)\n  - _Endpoints:_ `GET /me`\n\n## 2026-08-13\n\n**Webhooks**\n\n- **Added:** Document answers in `question_answers` now accept `external_id`, the document's identifier in your own system. A document sent again under an external id that was used before on the same order, consignment or stop replaces the earlier one instead of being added next to it. The identifier must point at a single document, not at the order or consignment it belongs to.\n  - _Affects:_ [Order](/docs/api-order)\n  - _Endpoints:_ [POST /v1/webhook/partial-order-update](/docs/webhooks-inbound/partial-order-update)\n\n## 2026-08-12\n\n**API**\n\n- **Changed:** Charge `status` now reports `INVOICE_POSTED` for charges on a posted invoice and `DO_NOT_INVOICE` for charges excluded from invoicing. These were previously reported as `CREATED`, including on existing charges, so invoiced and uninvoiced charges can now be told apart. Treat the status as an open set and map unrecognised values to `CREATED`.\n  - _Affects:_ [Order](/docs/use-case-order), [Customer portal](/docs/use-case-customer-portal)\n  - _Endpoints:_ `GET /v1/orders/order/{order_id}/charges`, `POST /v1/orders/order/{order_id}/charges/approval`\n\n## 2026-08-11\n\n**Outgoing data**\n\n- **Added:** `VisibilityOrderStatus` in operational visibility payloads gains `BLOCKED`, for an order that is blocked or on hold. Treat the order status as an open set and ignore values you do not recognise rather than rejecting the event.\n  - _Affects:_ [Customer portal](/docs/use-case-customer-portal), [Order](/docs/use-case-order), [Visibility](/docs/use-case-visibility)\n\n## 2026-08-10\n\n**Webhooks**\n\n- **Added:** Intermodal status updates now accept `external_id`, the booking's identifier in your own system. When supplied, it is stored as the identifier for the booking, taking precedence over `booking_reference`.\n  - _Affects:_ [Intermodal](/docs/use-case-intermodal-partner)\n  - _Endpoints:_ [POST /v1/webhook/intermodal-status](/docs/webhooks-inbound/intermodal-booking-status-webhook)\n\n## 2026-08-06\n\n**Webhooks**\n\n- **Added:** The document-import webhook now accepts `UK_EXPORTER_DRA` and `UK_IMPORTER_DRA` as `document_type` values.\n  - _Affects:_ [Document import](/docs/use-case-document-import)\n  - _Endpoints:_ `POST /v1/webhook/document-import`\n\n## 2026-08-05\n\n**API**\n\n- **Added:** The intermodal booking payload now includes a `trip` object with the trip's `id`, `name`, `status` and `custom_fields`, so trip-level data (e.g. a customs procedure) can be used when dispatching bookings.\n  - _Affects:_ [Intermodal](/docs/use-case-intermodal-partner)\n- **Deprecated:** The root-level `trip_name` field on the intermodal booking payload is deprecated; use `trip.name` instead.\n  - _Affects:_ [Intermodal](/docs/use-case-intermodal-partner)\n- **Fixed:** Deleting a resource unavailability that is already deleted now reliably returns `204`: the request no longer fails with a `500` when the unavailability is gone.\n  - _Affects:_ [Resource](/docs/api-resource)\n  - _Endpoints:_ `DELETE /v1/resources/resource/{resource_id}/unavailability/{id}`\n\n**Outgoing data**\n\n- **Added:** `ResourceType` in operational visibility payloads gains `HANDLING`, for handling equipment such as a forklift assigned to a stop, and `SUBCONTRACTOR`, which the payload has been able to carry for some time but was undocumented. Treat the resource type as an open set and ignore values you do not recognise rather than rejecting the event.\n  - _Affects:_ [Customer portal](/docs/use-case-customer-portal), [Order](/docs/use-case-order), [Visibility](/docs/use-case-visibility)\n\n## 2026-08-03\n\n**API**\n\n- **Added:** `pricing` now includes `by_currency`, holding the pricing totals per currency keyed by currency code. Each entry covers only the charges in that currency, so an order charged in more than one currency reports a correct total per currency.\n  - _Affects:_ [Order](/docs/api-order)\n  - _Endpoints:_ [GET /v1/orders/order/{order_id}](/docs/api-order/get_order_details_v1_orders_order__order_id__get), [GET /v1/orders/order/{order_id}/status](/docs/api-order/order_status_v1_orders_order__order_id__status_get)\n\n## 2026-07-31\n\n**API**\n\n- **Fixed:** Deleting a resource unavailability that is already deleted now returns `204` instead of failing with a `400`, so a retried delete no longer has to be special-cased. Updating an unavailability that does not exist now returns `404` naming the id, instead of a `400` reporting `Instance matching query does not exist`.\n  - _Affects:_ [Resource](/docs/api-resource)\n  - _Endpoints:_ `PUT /v1/resources/resource/{resource_id}/unavailability/{id}`, `DELETE /v1/resources/resource/{resource_id}/unavailability/{id}`\n\n## 2026-07-29\n\n**API**\n\n- **Added:** Master data can now be looked up by filter instead of by paging through the full list. Companies accept `code` and `accounting_customer_code`, and accounts, tax rates and resource groups accept `code`. Every filter also has a batch form taking a comma-separated list, spelled `code:in=A,B`; the existing `from_currency` and `to_currency` filters on exchange rates gain the same batch form. The exact and the batch spelling of the same filter cannot be combined, and a batch list accepts at most 100 values. `accounting_customer_code` holds the code of the default billing entity.\n  - _Affects:_ [Accounting](/docs/api-accounting), [Company](/docs/api-company), [Resource](/docs/api-resource)\n  - _Endpoints:_ `GET /v1/accounting/accounts`, `GET /v1/accounting/company`, `GET /v1/accounting/exchange-rate`, `GET /v1/accounting/tax-rates`, `GET /v1/companies/company`, `GET /v1/resources/resource_groups`\n- **Fixed:** Following `next_cursor` on a filtered list request now keeps the filters applied. The second and later pages previously returned the full unfiltered list.\n  - _Affects:_ [Accounting](/docs/api-accounting), [Company](/docs/api-company), [Resource](/docs/api-resource)\n  - _Endpoints:_ `GET /v1/accounting/company`, `GET /v1/accounting/exchange-rate`, `GET /v1/companies/company`, `GET /v1/resources/resource`, `GET /v1/resources/resource_groups`\n- **Changed:** An invalid value in `external_id:in` or `resource_type:in` is now reported as a validation error (422) rather than a bad request (400), matching how an invalid `resource_type` is already reported. An empty list such as `external_id:in=` is rejected as a bad request (400) instead of silently matching nothing, and a list accepts at most 100 values.\n  - _Affects:_ [Resource](/docs/api-resource)\n  - _Endpoints:_ `GET /v1/resources/resource`\n\n**Outgoing data**\n\n- **Changed:** `location.name` is no longer guaranteed in operational visibility payloads. A location without a name, such as an address-only one created automatically by an order import, previously blocked the entire visibility event from being sent; it is now sent with `name` omitted. Treat the field as optional and fall back to `address` and `city` when it is absent.\n  - _Affects:_ [Customer portal](/docs/use-case-customer-portal), [Order](/docs/use-case-order), [Visibility](/docs/use-case-visibility)\n\n## 2026-07-24\n\n**Webhooks**\n\n- **Added:** Consignment updates now support `CANCEL` and `UNCANCEL` operations. `CANCEL` moves a consignment to `CANCELLED` and takes its stops off the active route while keeping the record for invoicing and audit, unlike `DELETE`, which removes it entirely. `UNCANCEL` reverts a cancelled consignment to a plannable state. Both require a consignment match, and `UNCANCEL` applies only to a consignment that is currently cancelled.\n  - _Affects:_ [Order](/docs/api-order)\n  - _Endpoints:_ [POST /v1/webhook/partial-order-update](/docs/webhooks-inbound/partial-order-update)\n\n## 2026-07-23\n\n**API**\n\n- **Fixed:** Updating a resource no longer returns a server error when `note` or `external_id` is omitted; the value is now stored as an empty string, matching create. Sending an explicit `null` for `note`, `external_id`, `name`, or `locale` is now rejected with a validation error (422) instead of failing with a server error on update, or being silently ignored on create.\n  - _Affects:_ [Resource](/docs/api-resource)\n  - _Endpoints:_ `POST /v1/resources/resource`, `PUT /v1/resources/resource/{resource_id}`, `PATCH /v1/resources/resource/{resource_id}`\n- **Added:** Stops in order status responses now include `stop_type`, identifying the consignment pickup (`PICKUP`) and delivery (`DELIVERY`) stops. The field is empty for other stops.\n  - _Affects:_ [Order](/docs/api-order)\n  - _Endpoints:_ `GET /v1/orders/order/{order_id}/status`\n- **Added:** `resource_type` can now be `BARGE` or `AIRPLANE`, used by the resources that barge and air intermodal connections create.\n  - _Affects:_ Order, Resource, Trip\n  - _Endpoints:_ [GET /v1/orders/order/{order_id}/status](/docs/api-order/order_status_v1_orders_order__order_id__status_get), `GET /v1/resources/resource`, [GET /v1/trips/trip/{trip_id}](/docs/api-trip/get_trip_by_id_v1_trips_trip__trip_id__get)\n\n**Outgoing data**\n\n- **Added:** Resources in visibility events can now report the `BARGE` and `AIRPLANE` types.\n  - _Affects:_ [Customer portal](/docs/use-case-customer-portal), [Order](/docs/use-case-order), [Visibility](/docs/use-case-visibility)\n\n## 2026-07-22\n\n**API**\n\n- **Removed:** Order status responses no longer include `first_pickup_stop`. The same information can be derived from the `stops` array, which is ordered by stop sequence: the first stop with a pickup `activity_label` is the first pickup stop, and likewise the last stop with a delivery `activity_label` is the last delivery stop.\n  - _Affects:_ [Order](/docs/api-order)\n  - _Endpoints:_ `GET /v1/orders/order/{order_id}/status`\n\n## 2026-07-20\n\n**API**\n\n- **Added:** Resource create, update and patch now accept `is_archived`. Sending `is_archived: false` reactivates a previously archived resource, restoring it with its existing data; sending `true` archives it. Omitting the field leaves the archive state unchanged.\n  - _Affects:_ [Resource](/docs/api-resource)\n  - _Endpoints:_ `POST /v1/resources/resource`, `PUT /v1/resources/resource/{resource_id}`, `PATCH /v1/resources/resource/{resource_id}`\n\n## 2026-07-14\n\n**API**\n\n- **Fixed:** Payment status updates now accept `UNPAID`. Reporting an invoice as `UNPAID` reopens its payment task and clears the paid amount and date on the invoice; previously the documented `UNPAID` value was rejected with a validation error.\n  - _Affects:_ [Accounting](/docs/api-accounting)\n  - _Endpoints:_ `POST /v1/accounting/sales-invoice/{id}/payment/update-status`, `POST /v1/accounting/purchase-invoice/{id}/payment/update-status`\n\n**Webhooks**\n\n- **Added:** Intermodal booking status updates can report estimated and actual stop times via `stop_timestamps`, with `eta_timestamp`, `actual_start_timestamp` and `actual_end_timestamp` for the `departure` and `arrival` stops. The timestamps are only applied when the integration is configured to sync stop times.\n  - _Affects:_ [Intermodal partner](/docs/use-case-intermodal-partner)\n  - _Endpoints:_ [POST /v1/webhook/intermodal-status](/docs/webhooks-inbound/intermodal-booking-status-webhook)\n\n## 2026-07-10\n\n**API**\n\n- **Added:** Order status responses now include `first_pickup_stop`.\n  - _Affects:_ [Order](/docs/api-order)\n  - _Endpoints:_ `GET /v1/orders/order/{order_id}/status`\n- **Changed:** `last_delivery_stop` now uses the documented order-status stop shape.\n  - _Affects:_ [Order](/docs/api-order)\n  - _Endpoints:_ `GET /v1/orders/order/{order_id}/status`\n\n## 2026-07-09\n\n**API**\n\n- **Added:** `GET /v1/resources/resource` now documents the supported query filters: `cursor`, `updated_after`, `external_id`, `external_id:in`, `resource_type` and `resource_type:in`.\n  - _Affects:_ [Resource](/docs/api-resource)\n  - _Endpoints:_ `GET /v1/resources/resource`\n\n## 2026-07-07\n\n**API**\n\n- **Added:** Sales invoice and sales credit note responses now include `e_invoicing` registration metadata.\n  - _Affects:_ [Accounting](/docs/api-accounting), [Task](/docs/api-task)\n\n## 2026-07-06\n\n**API**\n\n- **Changed:** Validation error responses now return an `errors` array instead of the flat `detail`, `field` and `path` fields. Each item is a `ValidationErrorDetail` with `message`, `field`, `path` and `detail`; the array is always present and non-empty, so a single failure is a one-item array and integrators can handle one and many failures the same way.\n  - _Affects:_ [Accounting](/docs/api-accounting), [Authentication](/docs/api-authentication), [Company](/docs/api-company), [Document](/docs/api-document), [Order](/docs/api-order), [Resource](/docs/api-resource), [Task](/docs/api-task), [Trip](/docs/api-trip)\n\n## 2026-07-03\n\n**API**\n\n- **Added:** New `GET /v1/resources/resource_groups` endpoint lists the tenant's resource groups (`id`, `name`, `code`), cursor-paginated. Archived groups are excluded.\n  - _Affects:_ [Resource](/docs/api-resource)\n- **Added:** Resource responses now include `resource_groups`, the groups the resource currently belongs to (deduplicated and sorted by name). A resource can belong to more than one group.\n  - _Affects:_ [Resource](/docs/api-resource)\n- **Added:** `PATCH /v1/resources/resource/{resource_id}` accepts a `resource_group` reference to allocate the resource to a group, or `null` to remove it from its current group.\n  - _Affects:_ [Resource](/docs/api-resource)\n  - _Endpoints:_ `PATCH /v1/resources/resource/{resource_id}`\n\n## 2026-07-02\n\n**API**\n\n- **Added:** Location objects now include `customs_metadata` (with `customs_office_code`) alongside `terminal_metadata`.\n  - _Affects:_ [Order](/docs/api-order), [Trip](/docs/api-trip)\n\n## 2026-07-01\n\n**API**\n\n- **Added:** Added the Location master-data API to create, update and retrieve locations, including address and opening hours. New endpoints: `POST` and `GET` `/v1/locations/location`, and `GET`, `PUT` and `PATCH` `/v1/locations/location/{location_id}`.\n  - _Affects:_ [Location](/docs/api-location)\n\n## 2026-06-15\n\n**Outgoing data**\n\n- **Added:** The location dispatch webhook now includes a per-consignment `tracking_link`.\n  - _Affects:_ [Location booking](/docs/use-case-location-booking)\n\n## 2026-06-03\n\n**Outgoing data**\n\n- **Added:** Operational order visibility now includes goods information.\n  - _Affects:_ [Customer portal](/docs/use-case-customer-portal), [Order](/docs/use-case-order), [Visibility](/docs/use-case-visibility)\n\n## 2026-05-28\n\n**Outgoing data**\n\n- **Added:** Outgoing data now includes ADR hazard labels and `special_provisions` for dangerous goods.\n  - _Affects:_ [Order](/docs/api-order)\n\n## 2026-05-23\n\n**API**\n\n- **Added:** `Booking` now exposes `vessel`, `voyage`, `IMO` and the associated references for intermodal flows.\n  - _Affects:_ [Intermodal](/docs/use-case-intermodal-partner)\n\n## 2026-05-20\n\n**API**\n\n- **Added:** `ContainerStandardSize` gains the `FEET_24` and `FEET_26` values.\n\n## 2026-05-19\n\n**API**\n\n- **Added:** The `DocumentType` enum is synced with the TMS, adding 23 new document types.\n  - _Affects:_ Resource\n  - _Endpoints:_ `POST /v1/resources/resource/{resource_id}/validity`, `PUT /v1/resources/resource/{resource_id}/validity/{id}`\n\n## 2026-05-18\n\n**API**\n\n- **Added:** The `TaskType` enum gains `DISPATCH`, returned by the available-tasks and task endpoints.\n  - _Affects:_ [Accounting](/docs/api-accounting), [Task](/docs/api-task)\n\n## 2026-05-12\n\n**Outgoing data**\n\n- **Changed:** `compatible_extras` has been renamed to `extras` for consistency across resource models.\n  - _Affects:_ [Order](/docs/api-order), [Resource](/docs/api-resource), [Trip](/docs/api-trip)\n\n## 2026-05-07\n\n**API**\n\n- **Added:** `Booking` now exposes `seal_number`.\n  - _Affects:_ [Intermodal](/docs/use-case-intermodal-partner)\n\n## 2026-05-05\n\n**API**\n\n- **Added:** `CreditNoteStatus` gains the `PRE_INVOICED` value.\n  - _Affects:_ [Accounting](/docs/use-case-accounting), [Visibility](/docs/use-case-visibility)\n\n## 2026-04-27\n\n**API**\n\n- **Added:** Order models now expose `is_consignment_info_validated`, indicating whether consignment information has been validated.\n  - _Affects:_ [Order](/docs/api-order)\n- **Added:** Goods and handling units now return their `id` in order output, and `ContainerType` exposes the `container_iso_code`.\n  - _Affects:_ [Order](/docs/api-order)\n- **Added:** `ShippingRoute` now exposes `custom_fields` and `modality`.\n  - _Affects:_ [Intermodal](/docs/use-case-intermodal-partner)\n\n## 2026-04-24\n\n**API**\n\n- **Added:** `ResourceTypeEnum` gains `CHASSIS`, and `TimeWindow` exposes `use_location_opening_hours`.\n  - _Affects:_ [Order](/docs/api-order), [Trip](/docs/api-trip)\n\n## 2026-04-21\n\n**API**\n\n- **Added:** Resource and equipment models (`Container`, `Trailer`, `Vehicle` and their resource variants) now expose their `id`, and driver resources expose `start_stop_location`.\n  - _Affects:_ [Resource](/docs/api-resource)\n\n## 2026-04-17\n\n**API**\n\n- **Added:** `PartialOrderUpdate` now accepts an `update` object carrying order entity changes.\n  - _Affects:_ Order\n  - _Endpoints:_ [POST /v1/webhook/partial-order-update](/docs/webhooks-inbound/partial-order-update)\n\n## 2026-04-14\n\n**Webhooks**\n\n- **Added:** Added the `/v1/webhook/e-invoicing` inbound webhook.\n  - _Affects:_ [E-invoicing](/docs/use-case-e-invoicing)\n\n## 2026-04-13\n\n**API**\n\n- **Changed:** `BookingDimensions` now exposes `cargo_weight`, `tare_weight` and `verified_gross_mass`; the single `weight` field is deprecated.\n  - _Affects:_ [Intermodal](/docs/use-case-intermodal-partner)\n- **Deprecated:** Companies now use `credit_policy`; the `credit_limit_total` field is deprecated.\n  - _Affects:_ [Accounting](/docs/api-accounting), [Company](/docs/api-company)\n\n## 2026-04-08\n\n**API**\n\n- **Added:** Added a `/me` endpoint returning the authenticated API user.\n  - _Affects:_ [System](/docs/system)\n\n## 2026-04-07\n\n**API**\n\n- **Added:** Added the `/v1/accounting/exchange-rate` endpoint.\n  - _Affects:_ [Accounting](/docs/api-accounting)\n- **Added:** Consignments now expose `import_export`, and `ContactType` gains `SALES`, `CUSTOMS`, `IT`, `QUALITY`, `CLAIMS_INSURANCE` and `CUSTOMER_CONTACT`.\n  - _Affects:_ [Accounting](/docs/api-accounting), [Company](/docs/api-company), [Order](/docs/api-order), [Trip](/docs/api-trip)\n- **Added:** `Customs` exposes `has_customs_territory_crossing`, `PackagedItem` exposes `total_net_weight_kg`, and `PackagingType` exposes `export_alias`.\n  - _Affects:_ [Order](/docs/api-order)\n\n**Webhooks**\n\n- **Added:** Added the `/v1/webhook/tracking-update` inbound webhook.\n  - _Affects:_ [Tracking](/docs/use-case-tracking)\n\n## 2026-03-23\n\n**Outgoing data**\n\n- **Added:** Fleet and subcontractor dispatch payloads now include `custom_fields`.\n  - _Affects:_ [Fleet dispatch](/docs/use-case-fleet-dispatch), [Subcontractor dispatch](/docs/use-case-subcontractor-dispatch)\n\n## 2026-03-17\n\n**API**\n\n- **Added:** Location output now includes `latitude` and `longitude`.\n  - _Affects:_ [Accounting](/docs/api-accounting), [Company](/docs/api-company), [Order](/docs/api-order), [Task](/docs/api-task), [Trip](/docs/api-trip)\n\n## 2026-03-13\n\n**API**\n\n- **Changed:** Company create and update inputs now accept `archived_customer` and `archived_subcontractor`, and these read-only fields are no longer returned on company output: `purchase`, `sales`, `credit_limit_total` and `timestamp_updated`.\n  - _Affects:_ [Accounting](/docs/api-accounting), [Company](/docs/api-company), [Order](/docs/api-order), [Trip](/docs/api-trip)\n\n## 2026-03-11\n\n**API**\n\n- **Added:** `PackagedItem` now exposes `import_export`.\n  - _Affects:_ Order\n  - _Endpoints:_ [GET /v1/orders/order/{order_id}/export](/docs/api-order/order_export_v1_orders_order__order_id__export_get), [POST /v1/orders/order/upload](/docs/api-order/import_order_v1_orders_order_upload_post), [POST /v1/webhook](/docs/webhooks-inbound/order-import-webhook)\n\n**Webhooks**\n\n- **Added:** Added the `/v1/webhook/document-import` inbound webhook.\n  - _Affects:_ [Document import](/docs/use-case-document-import)\n- **Added:** Fleet status-update webhooks accept stop-group ETA windows via `eta_start` and `eta_end`.\n  - _Affects:_ Fleet dispatch\n  - _Endpoints:_ [POST /v1/webhook/fleet-status-update](/docs/webhooks-inbound/fleet-status-update-webhook)\n\n## 2026-03-10\n\n**Outgoing data**\n\n- **Added:** Operational order visibility now includes stop ETA times (`eta_start_time`, `eta_end_time`).\n  - _Affects:_ [Customer portal](/docs/use-case-customer-portal), [Order](/docs/use-case-order), [Visibility](/docs/use-case-visibility)\n\n## 2026-02-27\n\n**API**\n\n- **Changed:** Partial order updates now accept `consignment`; the top-level `id` field is deprecated.\n  - _Affects:_ Order\n  - _Endpoints:_ [POST /v1/webhook/partial-order-update](/docs/webhooks-inbound/partial-order-update)\n\n## 2026-02-24\n\n**API**\n\n- **Deprecated:** Deprecated `container_load_unload_stop` on order models.\n  - _Affects:_ [Order](/docs/api-order)\n- **Added:** `PackagedItem` now exposes `barcodes`, `packaging_type` and unit dimensions (`unit_height_m`, `unit_length_m`, `unit_width_m`).\n  - _Affects:_ Order\n  - _Endpoints:_ [GET /v1/orders/order/{order_id}/export](/docs/api-order/order_export_v1_orders_order__order_id__export_get), [POST /v1/orders/order/upload](/docs/api-order/import_order_v1_orders_order_upload_post), [POST /v1/webhook](/docs/webhooks-inbound/order-import-webhook)\n\n**Webhooks**\n\n- **Added:** Fleet status-update webhooks accept stop ETA windows via `eta_start` and `eta_end`.\n  - _Affects:_ Fleet dispatch, Subcontractor dispatch\n  - _Endpoints:_ [POST /v1/webhook/fleet-status-update](/docs/webhooks-inbound/fleet-status-update-webhook), [POST /v1/webhook/subco-status-update](/docs/webhooks-inbound/subcontractor-status-update-webhook)\n\n## 2026-02-16\n\n**API**\n\n- **Changed:** Purchase e-invoice and e-credit-note inputs now accept `attachments`; the `id` and `is_credit_note` fields are removed.\n  - _Affects:_ E-invoicing\n  - _Endpoints:_ [POST /v1/webhook/e-invoicing](/docs/webhooks-inbound/e-invoicing-webhook)\n\n## 2026-02-10\n\n**API**\n\n- **Added:** Location output now includes the location `id`.\n  - _Affects:_ [Accounting](/docs/api-accounting), [Company](/docs/api-company), [Order](/docs/api-order), [Task](/docs/api-task), [Trip](/docs/api-trip)\n\n## 2026-01-23\n\n**API**\n\n- **Added:** Companies can be flagged as buyer/seller via `is_buyer_or_seller`, and consignments now accept and return `buyer` and `seller`.\n  - _Affects:_ [Accounting](/docs/api-accounting), [Company](/docs/api-company), [Order](/docs/api-order)\n- **Added:** Purchase e-invoices and e-credit-notes now include `invoice_type`.\n  - _Affects:_ E-invoicing\n  - _Endpoints:_ [POST /v1/webhook/e-invoicing](/docs/webhooks-inbound/e-invoicing-webhook)\n\n## 2026-01-16\n\n**API**\n\n- **Changed:** Fleet resource models now expose `billing_entity`; on partial resource inputs the `company` field is replaced by `subcontractor` and `billing_entity`.\n  - _Affects:_ Resource\n  - _Endpoints:_ `PATCH /v1/resources/resource/{resource_id}`, `POST /v1/resources/resource`, `PUT /v1/resources/resource/{resource_id}`\n- **Added:** Companies now expose their `billing_entities`, `BillingEntity` exposes `id` and `is_default`, and `ContactType` gains `PAYMENT_REMINDERS`.\n  - _Affects:_ [Accounting](/docs/api-accounting), [Company](/docs/api-company), [Order](/docs/api-order), [Resource](/docs/api-resource), [Task](/docs/api-task), [Trip](/docs/api-trip)\n- **Removed:** Removed the unused `good_all` field from partial order updates.\n  - _Affects:_ Order\n  - _Endpoints:_ [POST /v1/webhook/partial-order-update](/docs/webhooks-inbound/partial-order-update)\n\n## 2026-01-09\n\n**API**\n\n- **Added:** `PaymentTermCode` gains additional terms: `NET_12`, `NET_20`, `NET_52`, `NET_75` and the `END_OF_MONTH_0_NET_{1,7,14,21,25}` variants.\n  - _Affects:_ [Accounting](/docs/api-accounting), [Company](/docs/api-company), [Order](/docs/api-order), [Task](/docs/api-task), [Trip](/docs/api-trip)\n\n**Outgoing data**\n\n- **Added:** Operational order visibility now includes the customer `id`.\n  - _Affects:_ [Customer portal](/docs/use-case-customer-portal), [Order](/docs/use-case-order), [Visibility](/docs/use-case-visibility)\n\n## 2026-01-05\n\n**API**\n\n- **Added:** Added the `/v1/accounting/sales-invoice/` and `/v1/accounting/sales-credit-note/` endpoints for creating sales invoices and credit notes.\n  - _Affects:_ [Accounting](/docs/api-accounting)\n- **Added:** `LineItem` now exposes `dimension_4`, `dimension_5` and `dimension_6`.\n  - _Affects:_ [Accounting](/docs/api-accounting), [Task](/docs/api-task)"}},"baseSlug":"/docs","routesMapping":{}}