Pharmacy
Order
Export Orders

Export Orders To Csv

Exports orders matching filters and returns CSV content and filename.

Overview

  • Method: POST
  • Path: /pharmacy/order/export-orders
  • Tags: pharmacy

Parameters

No parameters required.

Request Body

  • Content Type: application/json
  • Required: Yes

Fields

FieldTypeRequiredDetails
expandstringYes
fieldsstringYes
orderStatestringNo
orderSubStatestringNo
paymentStatestringNo
prescriptionStatestringNo
customerIdstringNoformat: uuid
pharmacyIdstringNoformat: uuid
clinicianIdstringNoformat: uuid
assignedbooleanNo
unassignedbooleanNo
unreadMessagesbooleanNo
unreadUpdatesbooleanNo
includeTagsstringYes
excludeTagsstringYes
deleted_atstringNo

Responses

200

Successful response

Content Type: application/json

{
  "csv": "string",
  "filename": "string",
  "count": 123
}

400

Bad Request

Content Type: application/json

{
  "error": "string",
  "details": [
    {}
  ]
}

401

Unauthorized

404

Not Found

500

Internal Server Error

Example Usage

curl -X POST \
  https://api.pillexa.com/pharmacy/order/export-orders \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}'