> ## Documentation Index
> Fetch the complete documentation index at: https://developers.gojoe.de/llms.txt
> Use this file to discover all available pages before exploring further.

# Who am I

> The integration account this key belongs to and the pharmacies it can act for, with the scopes per pharmacy. Use it as a connection test.



## OpenAPI

````yaml /openapi.yaml get /me
openapi: 3.1.0
info:
  title: GO JOE Pharmacy API
  version: 1.0.0-prototype
  summary: >-
    Receive GO JOE orders in your ERP, report back what happens to them, and
    keep GO JOE's stock and prices current.
  description: >
    The GO JOE Pharmacy API lets a pharmacy (or the ERP of a pharmacy group)

    receive paid, doctor-approved GO JOE orders and report their progress.


    **How it works**


    1. GO JOE sends a short, signed **webhook** (`order.created`) to your
    endpoint.

    2. Your ERP **fetches the full order** with `GET /orders/{id}` and downloads
    the
       prescription with `GET /orders/{id}/prescription`.
    3. You **accept** the order with your own order number (`POST
    /orders/{id}/accept`).

    4. You **report progress**: `packed`, `ready_for_pickup`,
    `out_for_delivery`,
       `completed` (`POST /orders/{id}/status`).
    5. Missed a webhook? Everything is also in the **event feed** (`GET
    /events`),
       which you can replay from your last cursor.
    6. Keep **stock and prices** current with `PUT
    /pharmacies/{pharmacy_id}/inventory`
       (whole catalogue or changed rows) and `PATCH …/inventory/{pharmacy_sku}` (one article).

    **Prescriptions come in two stages.** An order appears as soon as the

    *Vorab-Rezept* exists (`prescription.stage = vorab`). When the doctor's

    qualified electronic signature (QES) is done you receive

    `order.prescription_signed`; download the document again and file the signed

    version in place of the Vorab-Rezept.


    **Conventions:** JSON, UTF-8, timestamps in ISO-8601 UTC, money in integer

    cents (EUR, gross), quantities in g (flower) or ml (extracts). Ignore fields

    you don't know: new fields can appear at any time without a version change.

    Errors are `application/problem+json` with a stable `code`.
  contact:
    name: GO JOE Integrations
    email: support@gojoe.de
servers:
  - url: https://gojoe.de/api/pharm/v1
    description: Production (live keys, gj_live_…)
  - url: https://sandbox-api.gojoe.de/api/pharm/v1
    description: Sandbox (test keys, gj_test_…; fake orders and MUSTER prescriptions only)
security:
  - apiKey: []
tags:
  - name: Account
  - name: Orders
  - name: Events
  - name: Inventory
  - name: Webhooks
    description: What GO JOE sends to your webhook URL.
  - name: Sandbox
    description: >-
      Simulator endpoints. They exist on the sandbox only and answer 404 on
      production.
paths:
  /me:
    get:
      tags:
        - Account
      summary: Who am I
      description: >-
        The integration account this key belongs to and the pharmacies it can
        act for, with the scopes per pharmacy. Use it as a connection test.
      operationId: getMe
      responses:
        '200':
          description: Account and pharmacies
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Me'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    Me:
      type: object
      properties:
        account:
          type: object
          properties:
            id:
              type: string
              format: uuid
            name:
              type:
                - string
                - 'null'
        environment:
          type: string
          enum:
            - live
            - sandbox
        pharmacies:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
              name:
                type:
                  - string
                  - 'null'
              city:
                type:
                  - string
                  - 'null'
              scopes:
                type: array
                items:
                  type: string
    Problem:
      type: object
      required:
        - status
        - code
        - detail
        - request_id
      properties:
        type:
          type: string
          format: uri
        title:
          type: string
        status:
          type: integer
        code:
          type: string
          example: invalid_transition
          description: >
            Stable error code, e.g. `unauthorized`, `wrong_environment`,
            `insufficient_scope`,

            `rate_limited`, `order_not_found`, `not_accepted`,
            `already_accepted`,

            `invalid_transition`, `courier_managed_by_gojoe`, `order_cancelled`,

            `order_rejected`, `idempotency_key_reused`.
        detail:
          type: string
        request_id:
          type: string
          description: Quote this to GO JOE support.
  responses:
    Unauthorized:
      description: Missing, unknown or revoked key, or a key for the other environment
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    RateLimited:
      description: More than the account's limit (default 120) requests per minute
      headers:
        Retry-After:
          schema:
            type: integer
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: '`Authorization: Bearer gj_live_…` (production) or `gj_test_…` (sandbox).'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.