Skip to main content

​
Orders

Retrieve detailed order information including fulfillment orders, line items, shop data, and patient profiles.

​
Get Order Details

GET /v1/management/orders/{order_uid}
​
order_uid
string
required
The order UID
Required permission: order:read

​
Example Request

curl -X GET "https://api.rxscale.com/v1/management/orders/ord-abc123" \
  -H "X-API-Key: your-api-key-here"

​
Response

{
  "uid": "ord-abc123",
  "shop_orders": [
    {
      "uid": "so-789",
      "shop": {
        "uid": "shop-456",
        "identifier": "my-shop"
      },
      "external_id": "EXT-12345"
    }
  ],
  "patient_profile": {
    "uid": "pp-123",
    "created_at": 1711700000,
    "updated_at": 1711700000
  },
  "fulfillment_orders": [
    {
      "uid": "fo-001",
      "items": [
        {
          "uid": "foi-001",
          "order_item": {
            "uid": "oi-789",
            "quantity": 1,
            "sku_uid": "sku-456"
          }
        }
      ],
      "prescriptions": [
        {
          "uid": "px-001",
          "status": "signed",
          "doctor": {
            "uid": "doc-456",
            "display_name": "Dr. Schmidt"
          }
        }
      ]
    }
  ],
  "prescriptions": [
    {
      "uid": "px-001",
      "status": "signed"
    }
  ]
}

​
Prescription Data

Prescription data within orders (the prescriptions arrays on both the order and its fulfillment orders) is only included when your API key also has the prescription:read permission. Without it, these fields are returned as empty arrays.
If you need prescription details, ensure your API key has both order:read and prescription:read permissions. Contact your RxScale account manager to adjust permissions.