Get an order

Get an order

curl --request GET \
  --url https://gojoe.de/api/pharm/v1/orders/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://gojoe.de/api/pharm/v1/orders/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://gojoe.de/api/pharm/v1/orders/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://gojoe.de/api/pharm/v1/orders/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://gojoe.de/api/pharm/v1/orders/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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": "<string>",
    "tracking": {
      "number": "<string>",
      "url": "<string>"
    }
  },
  "patient": {
    "first_name": "<string>",
    "last_name": "<string>",
    "date_of_birth": "2023-12-25",
    "phone": "<string>",
    "shipping_address": {
      "street": "<string>",
      "additional": "<string>",
      "postcode": "<string>",
      "city": "<string>"
    }
  },
  "items": [
    {
      "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "form": "<string>",
      "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": "<string>",
      "phone": "<string>",
      "city": "<string>"
    },
    "document": {
      "version": "<string>",
      "url": "<string>"
    }
  },
  "erp_reference": "<string>",
  "accepted_at": "2023-11-07T05:31:56Z"
}

{
  "status": 123,
  "code": "invalid_transition",
  "detail": "<string>",
  "request_id": "<string>",
  "type": "<string>",
  "title": "<string>"
}

{
  "status": 123,
  "code": "invalid_transition",
  "detail": "<string>",
  "request_id": "<string>",
  "type": "<string>",
  "title": "<string>"
}

{
  "status": 123,
  "code": "invalid_transition",
  "detail": "<string>",
  "request_id": "<string>",
  "type": "<string>",
  "title": "<string>"
}

GET

orders

{id}

Get an order

curl --request GET \
  --url https://gojoe.de/api/pharm/v1/orders/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://gojoe.de/api/pharm/v1/orders/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://gojoe.de/api/pharm/v1/orders/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://gojoe.de/api/pharm/v1/orders/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://gojoe.de/api/pharm/v1/orders/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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": "<string>",
    "tracking": {
      "number": "<string>",
      "url": "<string>"
    }
  },
  "patient": {
    "first_name": "<string>",
    "last_name": "<string>",
    "date_of_birth": "2023-12-25",
    "phone": "<string>",
    "shipping_address": {
      "street": "<string>",
      "additional": "<string>",
      "postcode": "<string>",
      "city": "<string>"
    }
  },
  "items": [
    {
      "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "form": "<string>",
      "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": "<string>",
      "phone": "<string>",
      "city": "<string>"
    },
    "document": {
      "version": "<string>",
      "url": "<string>"
    }
  },
  "erp_reference": "<string>",
  "accepted_at": "2023-11-07T05:31:56Z"
}

{
  "status": 123,
  "code": "invalid_transition",
  "detail": "<string>",
  "request_id": "<string>",
  "type": "<string>",
  "title": "<string>"
}

{
  "status": 123,
  "code": "invalid_transition",
  "detail": "<string>",
  "request_id": "<string>",
  "type": "<string>",
  "title": "<string>"
}

{
  "status": 123,
  "code": "invalid_transition",
  "detail": "<string>",
  "request_id": "<string>",
  "type": "<string>",
  "title": "<string>"
}

Authorizations

Authorization

string

header

required

Authorization: Bearer gj_live_… (production) or gj_test_… (sandbox).

Path Parameters

string<uuid>

required

Response

The order

string<uuid>

required

order_number

string

required

Example:

"GO-XCAFTF"

pharmacy_id

string<uuid>

required

status

enum<string>

required

new → accepted → packed → ready_for_pickup | out_for_delivery → completed. returning/returned when a courier could not deliver. cancelled: do not dispense.

Available options:

new,

accepted,

packed,

ready_for_pickup,

out_for_delivery,

completed,

returning,

returned,

cancelled

created_at

string<date-time>

required

When the order reached your pharmacy

updated_at

string<date-time>

required

fulfilment

object

required

Show child attributes

patient

object

required

Only what is needed to dispense and deliver. No e-mail, no billing address.

Show child attributes

items

object[]

required

Show child attributes

totals

object

required

Show child attributes

prescription

object

required

Show child attributes

erp_reference

string | null

accepted_at

string<date-time> | null

Account

Orders

Events

Inventory

Sandbox

Webhooks

Authorizations

Path Parameters

Response