A unique string that identifies this request. Use a new value for
each new request, and the same value when you retry a request.
Within 24 hours, a retry with the same key returns the stored
response with the header Idempotent-Replayed: true. GO JOE does
not process the request again.
If the first request is still being processed, the retry returns
409 idempotency_in_progress. Retry after Retry-After seconds.
GO JOE does not store failed requests (4xx, 5xx). A retry is
processed again.
The same key with a different body returns
422 idempotency_key_reused.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"GO JOE Pharmacy API","colors":{"primary":"#3B82F6"},"logo":{"light":"https://mintcdn.com/gojoe/ZAZSDTe2whuO6FPg/logo/gojoe.svg?fit=max\u0026auto=format\u0026n=ZAZSDTe2whuO6FPg\u0026q=85\u0026s=99841f84f8fc20c0c4b841befd5dc359","dark":"https://mintcdn.com/gojoe/ZAZSDTe2whuO6FPg/logo/gojoe.svg?fit=max\u0026auto=format\u0026n=ZAZSDTe2whuO6FPg\u0026q=85\u0026s=99841f84f8fc20c0c4b841befd5dc359"},"favicon":"https://mintcdn.com/gojoe/ZAZSDTe2whuO6FPg/logo/gojoe.svg?fit=max\u0026auto=format\u0026n=ZAZSDTe2whuO6FPg\u0026q=85\u0026s=99841f84f8fc20c0c4b841befd5dc359","api":{"playground":{"display":"simple"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"gojoe","hasAudioNarration":false,"actualSubdomain":"gojoe","customDomains":["developers.gojoe.de"],"gitSource":{"type":"github","owner":"jules-2k","repo":"gojoe-v2","deployBranch":"main","contentDirectory":"docs/pharm-api","isPrivate":true,"mountPath":"","label":"","_id":"6af42d8b2fd0cd6f2258dbdc"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af465f429c5f814734275b6","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"API reference","count":14},{"language":"default","tag":"Guides","count":12},{"language":"default","tag":"Orders","count":6},{"language":"default","tag":"Inventory","count":3},{"language":"default","tag":"Get started","count":2},{"language":"default","tag":"Sandbox","count":2},{"language":"default","tag":"Account","count":1},{"language":"default","tag":"Events","count":1},{"language":"default","tag":"Webhooks","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/sandbox/simulate-a-go-joe-event","slug":"/api-reference/sandbox/simulate-a-go-joe-event","pageMetadata":{"title":"Simulate a GO JOE event","description":"**Sandbox only.** Simulates one event that the doctor, the courier or\nthe patient triggers in production.\n\n| `action` | Simulates | Event you receive |\n|---|---|---|\n| `sign_prescription` | The doctor signs. A signed MUSTER PDF replaces the Vorab-Rezept. | `order.prescription_signed` |\n| `replace_prescription` | A new Vorab-Rezept replaces the current one, as after a failed signature. | `order.prescription_replaced` |\n| `update_address` | The patient changes the delivery address. | `order.updated` |\n| `courier_picked_up` | Express orders: the courier collects the order. | `order.status_changed` (`out_for_delivery`) |\n| `courier_delivered` | Express orders: the courier delivers the order. | `order.status_changed` (`completed`) |\n| `courier_returning` | Express orders: the delivery fails and the courier returns the package. | `order.status_changed` (`returning`) |\n| `cancel` | The patient cancels the order. | `order.cancelled` |\n\nIf an action does not apply to the order, the API returns `409`.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml post /sandbox/orders/{id}/advance","href":"/api-reference/sandbox/simulate-a-go-joe-event","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n strong: \"strong\",\n table: \"table\",\n tbody: \"tbody\",\n td: \"td\",\n th: \"th\",\n thead: \"thead\",\n tr: \"tr\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Sandbox only.\"\n }), \" Simulates one event that the doctor, the courier or\\nthe patient triggers in production.\"]\n }), \"\\n\", _jsxs(_components.table, {\n children: [_jsx(_components.thead, {\n children: _jsxs(_components.tr, {\n children: [_jsx(_components.th, {\n children: _jsx(_components.code, {\n children: \"action\"\n })\n }), _jsx(_components.th, {\n children: \"Simulates\"\n }), _jsx(_components.th, {\n children: \"Event you receive\"\n })]\n })\n }), _jsxs(_components.tbody, {\n children: [_jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"sign_prescription\"\n })\n }), _jsx(_components.td, {\n children: \"The doctor signs. A signed MUSTER PDF replaces the Vorab-Rezept.\"\n }), _jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"order.prescription_signed\"\n })\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"replace_prescription\"\n })\n }), _jsx(_components.td, {\n children: \"A new Vorab-Rezept replaces the current one, as after a failed signature.\"\n }), _jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"order.prescription_replaced\"\n })\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"update_address\"\n })\n }), _jsx(_components.td, {\n children: \"The patient changes the delivery address.\"\n }), _jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"order.updated\"\n })\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"courier_picked_up\"\n })\n }), _jsx(_components.td, {\n children: \"Express orders: the courier collects the order.\"\n }), _jsxs(_components.td, {\n children: [_jsx(_components.code, {\n children: \"order.status_changed\"\n }), \" (\", _jsx(_components.code, {\n children: \"out_for_delivery\"\n }), \")\"]\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"courier_delivered\"\n })\n }), _jsx(_components.td, {\n children: \"Express orders: the courier delivers the order.\"\n }), _jsxs(_components.td, {\n children: [_jsx(_components.code, {\n children: \"order.status_changed\"\n }), \" (\", _jsx(_components.code, {\n children: \"completed\"\n }), \")\"]\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"courier_returning\"\n })\n }), _jsx(_components.td, {\n children: \"Express orders: the delivery fails and the courier returns the package.\"\n }), _jsxs(_components.td, {\n children: [_jsx(_components.code, {\n children: \"order.status_changed\"\n }), \" (\", _jsx(_components.code, {\n children: \"returning\"\n }), \")\"]\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"cancel\"\n })\n }), _jsx(_components.td, {\n children: \"The patient cancels the order.\"\n }), _jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"order.cancelled\"\n })\n })]\n })]\n })]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"If an action does not apply to the order, the API returns \", _jsx(_components.code, {\n children: \"409\"\n }), \".\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Simulate a GO JOE event","description":"**Sandbox only.** Simulates one event that the doctor, the courier or\nthe patient triggers in production.\n\n| `action` | Simulates | Event you receive |\n|---|---|---|\n| `sign_prescription` | The doctor signs. A signed MUSTER PDF replaces the Vorab-Rezept. | `order.prescription_signed` |\n| `replace_prescription` | A new Vorab-Rezept replaces the current one, as after a failed signature. | `order.prescription_replaced` |\n| `update_address` | The patient changes the delivery address. | `order.updated` |\n| `courier_picked_up` | Express orders: the courier collects the order. | `order.status_changed` (`out_for_delivery`) |\n| `courier_delivered` | Express orders: the courier delivers the order. | `order.status_changed` (`completed`) |\n| `courier_returning` | Express orders: the delivery fails and the courier returns the package. | `order.status_changed` (`returning`) |\n| `cancel` | The patient cancels the order. | `order.cancelled` |\n\nIf an action does not apply to the order, the API returns `409`.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml post /sandbox/orders/{id}/advance","href":"/api-reference/sandbox/simulate-a-go-joe-event","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Sandbox"],"operationId":"advanceSandboxOrder","summary":"Simulate a GO JOE event","description":"**Sandbox only.** Simulates one event that the doctor, the courier or\nthe patient triggers in production.\n\n| `action` | Simulates | Event you receive |\n|---|---|---|\n| `sign_prescription` | The doctor signs. A signed MUSTER PDF replaces the Vorab-Rezept. | `order.prescription_signed` |\n| `replace_prescription` | A new Vorab-Rezept replaces the current one, as after a failed signature. | `order.prescription_replaced` |\n| `update_address` | The patient changes the delivery address. | `order.updated` |\n| `courier_picked_up` | Express orders: the courier collects the order. | `order.status_changed` (`out_for_delivery`) |\n| `courier_delivered` | Express orders: the courier delivers the order. | `order.status_changed` (`completed`) |\n| `courier_returning` | Express orders: the delivery fails and the courier returns the package. | `order.status_changed` (`returning`) |\n| `cancel` | The patient cancels the order. | `order.cancelled` |\n\nIf an action does not apply to the order, the API returns `409`.\n","requestBody":"5f997838-7c96-4af1-9400-8068e5287ad7","responses":{"200":"c26ebdbf-1820-49f1-87b8-437718488764","401":"addc277e-41e0-4fda-957d-c0520f69d4e0","404":"eee7040b-fdea-4b64-bf83-6db636453a86","409":"a7302e72-baa7-480f-a152-c8e900e6188d","422":"dfc21d2b-beae-445b-95fa-6ecb3237ab94","429":"44736c8a-71f1-4ddd-95ca-06f119f1e53c"},"method":"post","type":"path","servers":["b1739830-04eb-48d9-8a46-fdd939aa6522","ce5d243f-a62d-4ec5-83d3-1e6fc1774211"],"security":["61205b06-996e-47a0-b91a-38adaddc760d"],"path":"/sandbox/orders/{id}/advance","baseUrlOptions":["https://gojoe.de/api/pharm/v1","https://sandbox-api.gojoe.de/api/pharm/v1"],"title":"Simulate a GO JOE event","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"ce258786-b84d-4170-90ef-e1e368977004":{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"}},"a8792ca0-110e-4002-a35f-c8fa77a4d542":{"name":"Idempotency-Key","in":"header","required":false,"description":"A unique string that identifies this request. Use a new value for\neach new request, and the same value when you retry a request.\n\n- Within 24 hours, a retry with the same key returns the stored\n response with the header `Idempotent-Replayed: true`. GO JOE does\n not process the request again.\n- If the first request is still being processed, the retry returns\n `409 idempotency_in_progress`. Retry after `Retry-After` seconds.\n- GO JOE does not store failed requests (`4xx`, `5xx`). A retry is\n processed again.\n- The same key with a different body returns\n `422 idempotency_key_reused`.\n","schema":{"type":"string","maxLength":255,"isRequired":false,"description":"A unique string that identifies this request. Use a new value for\neach new request, and the same value when you retry a request.\n\n- Within 24 hours, a retry with the same key returns the stored\n response with the header `Idempotent-Replayed: true`. GO JOE does\n not process the request again.\n- If the first request is still being processed, the retry returns\n `409 idempotency_in_progress`. Retry after `Retry-After` seconds.\n- GO JOE does not store failed requests (`4xx`, `5xx`). A retry is\n processed again.\n- The same key with a different body returns\n `422 idempotency_key_reused`.\n","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["action"],"properties":{"action":{"type":"string","enum":["sign_prescription","replace_prescription","update_address","courier_picked_up","courier_delivered","courier_returning","cancel"],"isRequired":true,"uniqueKey":"action","typeLabel":"enum\u003cstring>"}},"uniqueKey":"","typeLabel":"object"},"example":{"action":"sign_prescription"},"examples":{"Example":{"title":"Example","value":{"action":"sign_prescription"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"c26ebdbf-1820-49f1-87b8-437718488764":{"description":"The order after the simulated event","content":{"application/json":{"schema":{"type":"object","required":["id","order_number","pharmacy_id","status","created_at","updated_at","fulfilment","patient","items","totals","prescription"],"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"order_number":{"type":"string","example":"GO-XCAFTF","isRequired":true,"uniqueKey":"order_number","typeLabel":"string"},"pharmacy_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"pharmacy_id","typeLabel":"string\u003cuuid>"},"status":{"type":"string","enum":["new","accepted","packed","rejected","ready_for_pickup","out_for_delivery","completed","returning","returned","cancelled"],"description":"The usual sequence is `new` → `accepted` → `packed` →\n`ready_for_pickup` or `out_for_delivery` → `completed`.\n\n- `returning`, `returned`: the courier could not deliver the order.\n- `rejected`: you have reported that you cannot fill the order\n (`POST /orders/{id}/reject`).\n- `cancelled`: the order is cancelled. Do not dispense it.\n\nSee [Order lifecycle](https://developers.gojoe.de/guides/orders).\n","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"created_at":{"type":"string","format":"date-time","description":"The time the order became available to your pharmacy.","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"},"fulfilment":{"type":"object","properties":{"type":{"type":"string","enum":["express","shipping","pickup"],"uniqueKey":"fulfilment.type","typeLabel":"enum\u003cstring>"},"courier":{"type":"string","enum":["gojoe","pharmacy"],"description":"`gojoe`: GO JOE's courier collects the order. You report `packed` only. When the courier is booked depends on the pharmacy's `courier_booking` setting (see `GET /me`). `pharmacy`: you ship the order or hand it to the patient.","uniqueKey":"fulfilment.courier","typeLabel":"enum\u003cstring>"},"preferred_delivery_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"fulfilment.preferred_delivery_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"fulfilment.preferred_delivery_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfilment.preferred_delivery_at","typeLabel":"string\u003cdate-time> | null"},"pickup_slot_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"fulfilment.pickup_slot_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"fulfilment.pickup_slot_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfilment.pickup_slot_at","typeLabel":"string\u003cdate-time> | null"},"return_pin":{"oneOf":[{"type":"string","description":"Only for orders with GO JOE's courier. The courier needs this PIN to return a package that could not be delivered.","uniqueKey":"fulfilment.return_pin.oneOf.0","typeLabel":"string"},{"type":"null","description":"Only for orders with GO JOE's courier. The courier needs this PIN to return a package that could not be delivered.","uniqueKey":"fulfilment.return_pin.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfilment.return_pin","typeLabel":"string | null"},"tracking":{"oneOf":[{"type":"object","properties":{"number":{"oneOf":[{"type":"string","uniqueKey":"fulfilment.tracking.oneOf.0.number.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fulfilment.tracking.oneOf.0.number.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfilment.tracking.oneOf.0.number","typeLabel":"string | null"},"url":{"oneOf":[{"type":"string","uniqueKey":"fulfilment.tracking.oneOf.0.url.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fulfilment.tracking.oneOf.0.url.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfilment.tracking.oneOf.0.url","typeLabel":"string | null"}},"uniqueKey":"fulfilment.tracking.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"number":{"oneOf":[{"type":"string"},{"type":"null"}]},"url":{"oneOf":[{"type":"string"},{"type":"null"}]}},"uniqueKey":"fulfilment.tracking.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfilment.tracking","typeLabel":"object | null"}},"isRequired":true,"uniqueKey":"fulfilment","typeLabel":"object"},"patient":{"type":"object","description":"The patient data required to dispense and deliver the order. The API does not return the e-mail address or the billing address.","properties":{"first_name":{"oneOf":[{"type":"string","uniqueKey":"patient.first_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"patient.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"patient.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","uniqueKey":"patient.last_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"patient.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"patient.last_name","typeLabel":"string | null"},"date_of_birth":{"oneOf":[{"type":"string","format":"date","uniqueKey":"patient.date_of_birth.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","uniqueKey":"patient.date_of_birth.oneOf.1","typeLabel":"null"}],"uniqueKey":"patient.date_of_birth","typeLabel":"string\u003cdate> | null"},"phone":{"oneOf":[{"type":"string","uniqueKey":"patient.phone.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"patient.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"patient.phone","typeLabel":"string | null"},"shipping_address":{"oneOf":[{"type":"object","properties":{"street":{"oneOf":[{"type":"string","uniqueKey":"patient.shipping_address.oneOf.0.street.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"patient.shipping_address.oneOf.0.street.oneOf.1","typeLabel":"null"}],"uniqueKey":"patient.shipping_address.oneOf.0.street","typeLabel":"string | null"},"additional":{"oneOf":[{"type":"string","uniqueKey":"patient.shipping_address.oneOf.0.additional.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"patient.shipping_address.oneOf.0.additional.oneOf.1","typeLabel":"null"}],"uniqueKey":"patient.shipping_address.oneOf.0.additional","typeLabel":"string | null"},"postcode":{"oneOf":[{"type":"string","uniqueKey":"patient.shipping_address.oneOf.0.postcode.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"patient.shipping_address.oneOf.0.postcode.oneOf.1","typeLabel":"null"}],"uniqueKey":"patient.shipping_address.oneOf.0.postcode","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","uniqueKey":"patient.shipping_address.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"patient.shipping_address.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"patient.shipping_address.oneOf.0.city","typeLabel":"string | null"}},"uniqueKey":"patient.shipping_address.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"street":{"oneOf":[{"type":"string"},{"type":"null"}]},"additional":{"oneOf":[{"type":"string"},{"type":"null"}]},"postcode":{"oneOf":[{"type":"string"},{"type":"null"}]},"city":{"oneOf":[{"type":"string"},{"type":"null"}]}},"uniqueKey":"patient.shipping_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"patient.shipping_address","typeLabel":"object | null"}},"isRequired":true,"uniqueKey":"patient","typeLabel":"object"},"items":{"type":"array","items":{"type":"object","properties":{"product_id":{"type":"string","format":"uuid","description":"The GO JOE product ID.","uniqueKey":"\\items.items.[INDEX].product_id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","uniqueKey":"\\items.items.[INDEX].name","typeLabel":"string"},"form":{"oneOf":[{"type":"string","uniqueKey":"\\items.items.[INDEX].form.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"\\items.items.[INDEX].form.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].form","typeLabel":"string | null"},"quantity":{"type":"number","uniqueKey":"\\items.items.[INDEX].quantity","typeLabel":"number"},"unit":{"type":"string","enum":["g","ml"],"uniqueKey":"\\items.items.[INDEX].unit","typeLabel":"enum\u003cstring>"},"unit_price_cents":{"type":"integer","uniqueKey":"\\items.items.[INDEX].unit_price_cents","typeLabel":"integer"},"line_total_cents":{"type":"integer","uniqueKey":"\\items.items.[INDEX].line_total_cents","typeLabel":"integer"}},"uniqueKey":"\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"\\items","typeLabel":"object[]"},"totals":{"type":"object","properties":{"items_cents":{"type":"integer","uniqueKey":"totals.items_cents","typeLabel":"integer"},"delivery_fee_cents":{"type":"integer","uniqueKey":"totals.delivery_fee_cents","typeLabel":"integer"},"total_cents":{"type":"integer","uniqueKey":"totals.total_cents","typeLabel":"integer"},"currency":{"type":"string","enum":["EUR"],"uniqueKey":"totals.currency","typeLabel":"enum\u003cstring>"},"paid":{"type":"boolean","uniqueKey":"totals.paid","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"totals","typeLabel":"object"},"prescription":{"type":"object","properties":{"stage":{"type":"string","enum":["vorab","signed"],"uniqueKey":"prescription.stage","typeLabel":"enum\u003cstring>"},"issued_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"prescription.issued_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"prescription.issued_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"prescription.issued_at","typeLabel":"string\u003cdate-time> | null"},"signed_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"prescription.signed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"prescription.signed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"prescription.signed_at","typeLabel":"string\u003cdate-time> | null"},"doctor":{"oneOf":[{"type":"object","properties":{"name":{"oneOf":[{"type":"string","uniqueKey":"prescription.doctor.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"prescription.doctor.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"prescription.doctor.oneOf.0.name","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","uniqueKey":"prescription.doctor.oneOf.0.phone.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"prescription.doctor.oneOf.0.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"prescription.doctor.oneOf.0.phone","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","uniqueKey":"prescription.doctor.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"prescription.doctor.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"prescription.doctor.oneOf.0.city","typeLabel":"string | null"}},"uniqueKey":"prescription.doctor.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"name":{"oneOf":[{"type":"string"},{"type":"null"}]},"phone":{"oneOf":[{"type":"string"},{"type":"null"}]},"city":{"oneOf":[{"type":"string"},{"type":"null"}]}},"uniqueKey":"prescription.doctor.oneOf.1","typeLabel":"null"}],"uniqueKey":"prescription.doctor","typeLabel":"object | null"},"document":{"oneOf":[{"type":"object","properties":{"version":{"type":"string","description":"Changes when the PDF changes.","uniqueKey":"prescription.document.oneOf.0.version","typeLabel":"string"},"url":{"type":"string","description":"The path of `GET /orders/{id}/prescription` for this order.","uniqueKey":"prescription.document.oneOf.0.url","typeLabel":"string"}},"uniqueKey":"prescription.document.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"version":{"type":"string","description":"Changes when the PDF changes."},"url":{"type":"string","description":"The path of `GET /orders/{id}/prescription` for this order."}},"uniqueKey":"prescription.document.oneOf.1","typeLabel":"null"}],"uniqueKey":"prescription.document","typeLabel":"object | null"}},"isRequired":true,"uniqueKey":"prescription","typeLabel":"object"},"erp_reference":{"oneOf":[{"type":"string","uniqueKey":"erp_reference.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"erp_reference.oneOf.1","typeLabel":"null"}],"uniqueKey":"erp_reference","typeLabel":"string | null"},"accepted_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"accepted_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"accepted_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"accepted_at","typeLabel":"string\u003cdate-time> | null"},"rejected_at":{"oneOf":[{"type":"string","format":"date-time","description":"The time you rejected the order.","uniqueKey":"rejected_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The time you rejected the order.","uniqueKey":"rejected_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"rejected_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","order_number":"GO-XCAFTF","pharmacy_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","status":"new","created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z","fulfilment":{"type":"express","courier":"gojoe","preferred_delivery_at":"2023-11-07T05:31:56Z","pickup_slot_at":"2023-11-07T05:31:56Z","return_pin":"\u003cstring>","tracking":{"number":"\u003cstring>","url":"\u003cstring>"}},"patient":{"first_name":"\u003cstring>","last_name":"\u003cstring>","date_of_birth":"2023-12-25","phone":"\u003cstring>","shipping_address":{"street":"\u003cstring>","additional":"\u003cstring>","postcode":"\u003cstring>","city":"\u003cstring>"}},"items":[{"product_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"\u003cstring>","form":"\u003cstring>","quantity":123,"unit":"g","unit_price_cents":123,"line_total_cents":123}],"totals":{"items_cents":123,"delivery_fee_cents":123,"total_cents":123,"currency":"EUR","paid":true},"prescription":{"stage":"vorab","issued_at":"2023-11-07T05:31:56Z","signed_at":"2023-11-07T05:31:56Z","doctor":{"name":"\u003cstring>","phone":"\u003cstring>","city":"\u003cstring>"},"document":{"version":"\u003cstring>","url":"\u003cstring>"}},"erp_reference":"\u003cstring>","accepted_at":"2023-11-07T05:31:56Z","rejected_at":"2023-11-07T05:31:56Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"addc277e-41e0-4fda-957d-c0520f69d4e0":{"description":"The key is missing, unknown or revoked, or it belongs to the other environment","content":{"application/problem+json":{"schema":{"type":"object","required":["status","code","detail","request_id"],"properties":{"status":{"type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"code":{"type":"string","example":"invalid_transition","description":"The error code, for example `unauthorized`, `not_accepted` or\n`invalid_transition`. Codes do not change. The\n[error reference](https://developers.gojoe.de/guides/errors) lists all codes.\n","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"request_id":{"type":"string","description":"Identifies the request. Include it when you contact GO JOE.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"type":{"type":"string","format":"uri","description":"A link to this code in the error reference: `https://developers.gojoe.de/guides/errors#\u003ccode>`.","uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","uniqueKey":"title","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":123,"code":"invalid_transition","detail":"\u003cstring>","request_id":"\u003cstring>","type":"\u003cstring>","title":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"eee7040b-fdea-4b64-bf83-6db636453a86":{"description":"This key cannot access an order with this ID. The response is the same for orders of other accounts.","content":{"application/problem+json":{"schema":{"type":"object","required":["status","code","detail","request_id"],"properties":{"status":{"type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"code":{"type":"string","example":"invalid_transition","description":"The error code, for example `unauthorized`, `not_accepted` or\n`invalid_transition`. Codes do not change. The\n[error reference](https://developers.gojoe.de/guides/errors) lists all codes.\n","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"request_id":{"type":"string","description":"Identifies the request. Include it when you contact GO JOE.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"type":{"type":"string","format":"uri","description":"A link to this code in the error reference: `https://developers.gojoe.de/guides/errors#\u003ccode>`.","uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","uniqueKey":"title","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":123,"code":"invalid_transition","detail":"\u003cstring>","request_id":"\u003cstring>","type":"\u003cstring>","title":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"a7302e72-baa7-480f-a152-c8e900e6188d":{"description":"The current state does not allow the request (see `code`), or a request with the same `Idempotency-Key` is still being processed","content":{"application/problem+json":{"schema":{"type":"object","required":["status","code","detail","request_id"],"properties":{"status":{"type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"code":{"type":"string","example":"invalid_transition","description":"The error code, for example `unauthorized`, `not_accepted` or\n`invalid_transition`. Codes do not change. The\n[error reference](https://developers.gojoe.de/guides/errors) lists all codes.\n","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"request_id":{"type":"string","description":"Identifies the request. Include it when you contact GO JOE.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"type":{"type":"string","format":"uri","description":"A link to this code in the error reference: `https://developers.gojoe.de/guides/errors#\u003ccode>`.","uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","uniqueKey":"title","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":123,"code":"invalid_transition","detail":"\u003cstring>","request_id":"\u003cstring>","type":"\u003cstring>","title":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"dfc21d2b-beae-445b-95fa-6ecb3237ab94":{"description":"Invalid body","content":{"application/problem+json":{"schema":{"type":"object","required":["status","code","detail","request_id"],"properties":{"status":{"type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"code":{"type":"string","example":"invalid_transition","description":"The error code, for example `unauthorized`, `not_accepted` or\n`invalid_transition`. Codes do not change. The\n[error reference](https://developers.gojoe.de/guides/errors) lists all codes.\n","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"request_id":{"type":"string","description":"Identifies the request. Include it when you contact GO JOE.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"type":{"type":"string","format":"uri","description":"A link to this code in the error reference: `https://developers.gojoe.de/guides/errors#\u003ccode>`.","uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","uniqueKey":"title","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":123,"code":"invalid_transition","detail":"\u003cstring>","request_id":"\u003cstring>","type":"\u003cstring>","title":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"44736c8a-71f1-4ddd-95ca-06f119f1e53c":{"description":"The account sent more requests than its limit allows. The default is 120 requests per minute.","headers":{"Retry-After":{"schema":{"type":"integer"}}},"content":{"application/problem+json":{"schema":{"type":"object","required":["status","code","detail","request_id"],"properties":{"status":{"type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"code":{"type":"string","example":"invalid_transition","description":"The error code, for example `unauthorized`, `not_accepted` or\n`invalid_transition`. Codes do not change. The\n[error reference](https://developers.gojoe.de/guides/errors) lists all codes.\n","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"request_id":{"type":"string","description":"Identifies the request. Include it when you contact GO JOE.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"type":{"type":"string","format":"uri","description":"A link to this code in the error reference: `https://developers.gojoe.de/guides/errors#\u003ccode>`.","uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","uniqueKey":"title","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":123,"code":"invalid_transition","detail":"\u003cstring>","request_id":"\u003cstring>","type":"\u003cstring>","title":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"61205b06-996e-47a0-b91a-38adaddc760d":{"apiKey":{"type":"http","scheme":"bearer","description":"Send your key in the `Authorization` header: `Bearer gj_live_…` in production, `Bearer gj_test_…` in the sandbox.","scopes":[],"schemeName":"apiKey"}}},"servers":{"b1739830-04eb-48d9-8a46-fdd939aa6522":{"url":"https://gojoe.de/api/pharm/v1","description":"Production (live keys, gj_live_…)."},"ce5d243f-a62d-4ec5-83d3-1e6fc1774211":{"url":"https://sandbox-api.gojoe.de/api/pharm/v1","description":"Sandbox (test keys, gj_test_…). Contains test orders and MUSTER prescriptions only."}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Send your key in the `Authorization` header: `Bearer gj_live_…` in production, `Bearer gj_test_…` in the sandbox.","scopes":[],"schemeName":"apiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Send your key in the `Authorization` header: `Bearer gj_live_…` in production, `Bearer gj_test_…` in the sandbox.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"apiKey","name":"Authorization"}],"title":"apiKey"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"gojoe","siteName":"GO JOE Pharmacy API","title":"Simulate a GO JOE event - GO JOE Pharmacy API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-11T12:56:25.671Z","originalFileLocation":"api-reference/sandbox/simulate-a-go-joe-event.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Sandbox only. Simulates one event that the doctor, the courier or the patient triggers in production. | action | Simulates | Event you receive | |---|---|---| | sign_prescription | The doctor signs. A signed MUSTER PDF replaces the Vorab-Rezept. | order.prescription_signed | | replace_prescription | A new Vorab-Rezept replaces the current one, as after a failed signature. | order.prescription_replaced | | update_address | The patient changes the delivery address. | order.updated | | courier_picked_up | Express orders: the courier collects the order. | order.status_changed (out_for_delivery) | | courier_delivered | Express orders: the courier delivers the order. | order.status_changed (completed) | | courier_returning | Express orders: the delivery fails and the courier returns the package. | order.status_changed (returning) | | cancel | The patient cancels the order. | order.cancelled | If an action does not apply to the order, the API returns 409.\">\u003cmeta data-mint-head name=\"application-name\" content=\"GO JOE Pharmacy API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/gojoe/gPZf8lhhCeBvD2XW/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/gojoe/gPZf8lhhCeBvD2XW/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/gojoe/gPZf8lhhCeBvD2XW/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/gojoe/gPZf8lhhCeBvD2XW/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/gojoe/gPZf8lhhCeBvD2XW/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/gojoe/gPZf8lhhCeBvD2XW/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/gojoe/gPZf8lhhCeBvD2XW/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/gojoe/gPZf8lhhCeBvD2XW/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/gojoe/gPZf8lhhCeBvD2XW/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Simulate a GO JOE event - GO JOE Pharmacy API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Sandbox only. Simulates one event that the doctor, the courier or the patient triggers in production. | action | Simulates | Event you receive | |---|---|---| | sign_prescription | The doctor signs. A signed MUSTER PDF replaces the Vorab-Rezept. | order.prescription_signed | | replace_prescription | A new Vorab-Rezept replaces the current one, as after a failed signature. | order.prescription_replaced | | update_address | The patient changes the delivery address. | order.updated | | courier_picked_up | Express orders: the courier collects the order. | order.status_changed (out_for_delivery) | | courier_delivered | Express orders: the courier delivers the order. | order.status_changed (completed) | | courier_returning | Express orders: the delivery fails and the courier returns the package. | order.status_changed (returning) | | cancel | The patient cancels the order. | order.cancelled | If an action does not apply to the order, the API returns 409.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"GO JOE Pharmacy API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.gojoe.de/api-reference/sandbox/simulate-a-go-joe-event\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://gojoe.mintlify.site/_mintlify/api/og/v2?division=Sandbox\u0026amp;title=Simulate+a+GO+JOE+event\u0026amp;description=**Sandbox+only.**+Simulates+one+event+that+the+doctor%2C+the+courier+or%0Athe+patient+triggers+in+production.%0A%0A%7C+%60action%60+%7C+Simulates+%7C+Event+you+receive+%7C%0A%7C---%7C---\u0026amp;theme=22952e6d9f8aeb359d9b9816\u0026amp;signature=88b4ea23ac7f463b381233012fbb51b9888906ad675881a3b91b63042fc30d67\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Simulate a GO JOE event - GO JOE Pharmacy API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Sandbox only. Simulates one event that the doctor, the courier or the patient triggers in production. | action | Simulates | Event you receive | |---|---|---| | sign_prescription | The doctor signs. A signed MUSTER PDF replaces the Vorab-Rezept. | order.prescription_signed | | replace_prescription | A new Vorab-Rezept replaces the current one, as after a failed signature. | order.prescription_replaced | | update_address | The patient changes the delivery address. | order.updated | | courier_picked_up | Express orders: the courier collects the order. | order.status_changed (out_for_delivery) | | courier_delivered | Express orders: the courier delivers the order. | order.status_changed (completed) | | courier_returning | Express orders: the delivery fails and the courier returns the package. | order.status_changed (returning) | | cancel | The patient cancels the order. | order.cancelled | If an action does not apply to the order, the API returns 409.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://gojoe.mintlify.site/_mintlify/api/og/v2?division=Sandbox\u0026amp;title=Simulate+a+GO+JOE+event\u0026amp;description=**Sandbox+only.**+Simulates+one+event+that+the+doctor%2C+the+courier+or%0Athe+patient+triggers+in+production.%0A%0A%7C+%60action%60+%7C+Simulates+%7C+Event+you+receive+%7C%0A%7C---%7C---\u0026amp;theme=22952e6d9f8aeb359d9b9816\u0026amp;signature=88b4ea23ac7f463b381233012fbb51b9888906ad675881a3b91b63042fc30d67\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/gojoe/gPZf8lhhCeBvD2XW/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"GO JOE Pharmacy API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3B82F6\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.gojoe.de/api-reference/sandbox/simulate-a-go-joe-event\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/sandbox/simulate-a-go-joe-event.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.gojoe.de/#organization\",\"name\":\"GO JOE Pharmacy API\",\"url\":\"https://developers.gojoe.de\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/gojoe/ZAZSDTe2whuO6FPg/logo/gojoe.svg?fit=max\u0026auto=format\u0026n=ZAZSDTe2whuO6FPg\u0026q=85\u0026s=99841f84f8fc20c0c4b841befd5dc359\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.gojoe.de#website\",\"name\":\"GO JOE Pharmacy API\",\"url\":\"https://developers.gojoe.de\",\"publisher\":{\"@id\":\"https://developers.gojoe.de/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.gojoe.de/api-reference/sandbox/simulate-a-go-joe-event#webpage\",\"url\":\"https://developers.gojoe.de/api-reference/sandbox/simulate-a-go-joe-event\",\"name\":\"Simulate a GO JOE event\",\"description\":\"Sandbox only. Simulates one event that the doctor, the courier or the patient triggers in production. | action | Simulates | Event you receive | |---|---|---| | sign_prescription | The doctor signs. A signed MUSTER PDF replaces the Vorab-Rezept. | order.prescription_signed | | replace_prescription | A new Vorab-Rezept replaces the current one, as after a failed signature. | order.prescription_replaced | | update_address | The patient changes the delivery address. | order.updated | | courier_picked_up | Express orders: the courier collects the order. | order.status_changed (out_for_delivery) | | courier_delivered | Express orders: the courier delivers the order. | order.status_changed (completed) | | courier_returning | Express orders: the delivery fails and the courier returns the package. | order.status_changed (returning) | | cancel | The patient cancels the order. | order.cancelled | If an action does not apply to the order, the API returns 409.\",\"dateModified\":\"2026-11-11T12:56:25.671Z\",\"isPartOf\":{\"@id\":\"https://developers.gojoe.de#website\"},\"breadcrumb\":{\"@id\":\"https://developers.gojoe.de/api-reference/sandbox/simulate-a-go-joe-event#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.gojoe.de/api-reference/sandbox/simulate-a-go-joe-event#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Sandbox\",\"item\":\"https://developers.gojoe.de/api-reference/sandbox/create-a-test-order\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Simulate a GO JOE event\",\"item\":\"https://developers.gojoe.de/api-reference/sandbox/simulate-a-go-joe-event\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.gojoe.de/api-reference/sandbox/simulate-a-go-joe-event#apireference\",\"headline\":\"Simulate a GO JOE event\",\"name\":\"Simulate a GO JOE event\",\"description\":\"Sandbox only. Simulates one event that the doctor, the courier or the patient triggers in production. | action | Simulates | Event you receive | |---|---|---| | sign_prescription | The doctor signs. A signed MUSTER PDF replaces the Vorab-Rezept. | order.prescription_signed | | replace_prescription | A new Vorab-Rezept replaces the current one, as after a failed signature. | order.prescription_replaced | | update_address | The patient changes the delivery address. | order.updated | | courier_picked_up | Express orders: the courier collects the order. | order.status_changed (out_for_delivery) | | courier_delivered | Express orders: the courier delivers the order. | order.status_changed (completed) | | courier_returning | Express orders: the delivery fails and the courier returns the package. | order.status_changed (returning) | | cancel | The patient cancels the order. | order.cancelled | If an action does not apply to the order, the API returns 409.\",\"url\":\"https://developers.gojoe.de/api-reference/sandbox/simulate-a-go-joe-event\",\"mainEntityOfPage\":{\"@id\":\"https://developers.gojoe.de/api-reference/sandbox/simulate-a-go-joe-event#webpage\"},\"dateModified\":\"2026-11-11T12:56:25.671Z\",\"publisher\":{\"@id\":\"https://developers.gojoe.de/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.gojoe.de#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"GO JOE Pharmacy API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"GO JOE Pharmacy API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/sandbox/simulate-a-go-joe-event.md","siteName":"GO JOE Pharmacy API","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/quickstart"}]},{"tab":"API reference","groups":[{"group":"Account","pages":[{"title":"Get account and pharmacies","deprecated":null,"version":null,"openapi":"/openapi.yaml get /me","href":"/api-reference/account/get-account-and-pharmacies"}]},{"group":"Orders","pages":[{"title":"List orders","deprecated":null,"version":null,"openapi":"/openapi.yaml get /orders","href":"/api-reference/orders/list-orders"},{"title":"Get an order","deprecated":null,"version":null,"openapi":"/openapi.yaml get /orders/{id}","href":"/api-reference/orders/get-an-order"},{"title":"Download the prescription","deprecated":null,"version":null,"openapi":"/openapi.yaml get /orders/{id}/prescription","href":"/api-reference/orders/download-the-prescription"},{"title":"Accept an order","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/{id}/accept","href":"/api-reference/orders/accept-an-order"},{"title":"Report a status","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/{id}/status","href":"/api-reference/orders/report-a-status"},{"title":"Reject an order","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/{id}/reject","href":"/api-reference/orders/reject-an-order"}]},{"group":"Events","pages":[{"title":"Event feed","deprecated":null,"version":null,"openapi":"/openapi.yaml get /events","href":"/api-reference/events/event-feed"}]},{"group":"Inventory","pages":[{"title":"Push stock and prices","deprecated":null,"version":null,"openapi":"/openapi.yaml put /pharmacies/{pharmacy_id}/inventory","href":"/api-reference/inventory/push-stock-and-prices"},{"title":"Update one article","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /pharmacies/{pharmacy_id}/inventory/{pharmacy_sku}","href":"/api-reference/inventory/update-one-article"},{"title":"List pushed articles","deprecated":null,"version":null,"openapi":"/openapi.yaml get /inventory","href":"/api-reference/inventory/list-pushed-articles"}]},{"group":"Sandbox","pages":[{"title":"Create a test order","description":"**Sandbox only.** Creates a paid, doctor-approved test order for one\nof your pharmacies. You receive `order.created` as a webhook and in\nthe event feed, and you process the order with the same endpoints as\nin production.\n\nThe patient (Erika Mustermann) and the doctor (Dr. Max Mustermann) are\nfictitious. The prescription is a PDF marked **MUSTER**.\n\nWithout `items`, the order contains one or two products that the\npharmacy has in stock. With `items`, use article numbers that you have\npushed with `PUT /pharmacies/{pharmacy_id}/inventory` and that GO JOE\nhas mapped.\n\nYou can create up to 200 test orders per pharmacy in 24 hours\n(`429 sandbox_order_limit`).\n","deprecated":null,"version":null,"openapi":"/openapi.yaml post /sandbox/orders","href":"/api-reference/sandbox/create-a-test-order"},{"title":"Simulate a GO JOE event","deprecated":null,"version":null,"openapi":"/openapi.yaml post /sandbox/orders/{id}/advance","href":"/api-reference/sandbox/simulate-a-go-joe-event"}]},{"group":"Webhooks","pages":[{"title":"Event notification","description":"GO JOE sends this request to the webhook URL of your account for\nevery event. The request is signed according to the\n[Standard Webhooks](https://www.standardwebhooks.com) specification.\n\n- Verify `webhook-signature` with your `whsec_…` secret. The signature\n is the base64-encoded HMAC-SHA256 of\n `{webhook-id}.{webhook-timestamp}.{body}`.\n- Reject requests whose `webhook-timestamp` differs from the current\n time by more than 5 minutes.\n- Respond with `2xx` within 10 seconds. Process the event afterwards.\n- GO JOE retries failed deliveries for 24 hours. A retry has the same\n `webhook-id`. Use it to skip events that you have already processed.\n\nSee the [webhooks guide](https://developers.gojoe.de/guides/webhooks).\n","version":null,"deprecated":null,"openapi":"/openapi.yaml webhook event","href":"/api-reference/webhooks/event-notification"}]}]}]},"basePath":"","title":"Simulate a GO JOE event - GO JOE Pharmacy API","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CybtLBIt.js","utils-BMLj2fvV.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-B6In562Y.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dr8Mfhp9.js","snippetPresets-2rmQvMVl.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-WMqJYdZj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CJ-MlPHu.js","shallow-dY3TMRCk.js","getApiPlaygroundDisplay-v-1B2bKm.js","CodeSnippet-BDhiTB7U.js","CodeSnippets-D9hnzQcS.js","Page-C4GwDT3_.js","getPastedJson-Th2V45jI.js","icon-BQXch1W9.js","MethodPill-BCqUneP3.js","DuplicateIcon-Q_-bhurZ.js","createIcon-DUjLHRqp.js","DynamicMarkdown-B-f2cqXQ.js","SectionHeading-Da5NsV4v.js","axios-vUo_bRtp.js","Markdown-D13FWkIM.js","clsx-D3Isdib3.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C-XZBk9h.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink--qIqmmVG.js"]}