EndpointsProvider Orders

Provider Orders

Function-calling namespace: providerOrders

  • Base URL: https://api.aivida.in
  • Engine endpoint: POST /api
  • Auth: Stack token middleware enabled in optional mode.
  • Send token in header: x-stack-access-token: <access_token> (or Authorization: Bearer <access_token>).
  • In optional mode: no token is allowed; invalid token is rejected with 401.

create

Source: backend/endpoints/provider-orders/create

Input Fields

FieldTypeRequired
patientProfileIdstringYes
organizationIdstringYes
sourceTypestringYes
prescriptionIdstringNo
labOrderIdstringNo
appointmentIdstringNo
consultationIdstringNo
items[]models.ProviderOrderItemYes
subtotalfloat64No
statusstringYes
deliveryAddress*models.ProviderOrderDeliveryAddressNo
confirmedAt*int64No
packingAt*int64No
dispatchedAt*int64No
outForDeliveryAt*int64No
deliveredAt*int64No
patientNotesstringNo
providerNotesstringNo
razorpayOrderIdstringNo
razorpayPaymentIdstringNo
razorpaySignaturestringNo
paymentStatusstringNo
amountPaid*float64No
paidAt*int64No
paymentMethodstringNo
checkoutSessionIdstringNo
createdAt*int64No
updatedAt*int64No

Example Request

curl -X POST https://api.aivida.in/api \
  -H "Content-Type: application/json" \
  -H "x-stack-access-token: <access_token_optional>" \
  -d '{
  "namespace": "providerOrders",
  "apiName": "create",
  "data": {
    "patientProfileId": "patientprofile_123",
    "organizationId": "org_123",
    "sourceType": "GENERAL",
    "items": [],
    "status": "ACTIVE"
  }
}'

Example Response

{ "status": "ok", "data": {} }

delete

Source: backend/endpoints/provider-orders/delete

Input Fields

FieldTypeRequired
idstringYes
organizationIdstringYes

Example Request

curl -X POST https://api.aivida.in/api \
  -H "Content-Type: application/json" \
  -H "x-stack-access-token: <access_token_optional>" \
  -d '{
  "namespace": "providerOrders",
  "apiName": "delete",
  "data": {
    "id": "id_123",
    "organizationId": "org_123"
  }
}'

Example Response

{ "status": "ok", "data": {} }

getById

Source: backend/endpoints/provider-orders/get-by-id

Input Fields

FieldTypeRequired
idstringYes
organizationIdstringYes

Example Request

curl -X POST https://api.aivida.in/api \
  -H "Content-Type: application/json" \
  -H "x-stack-access-token: <access_token_optional>" \
  -d '{
  "namespace": "providerOrders",
  "apiName": "getById",
  "data": {
    "id": "id_123",
    "organizationId": "org_123"
  }
}'

Example Response

{ "status": "ok", "data": {} }

listByOrganization

Source: backend/endpoints/provider-orders/list-by-organization

Input Fields

FieldTypeRequired
organizationIdstringYes
pageintNo
pageSizeintNo

Example Request

curl -X POST https://api.aivida.in/api \
  -H "Content-Type: application/json" \
  -H "x-stack-access-token: <access_token_optional>" \
  -d '{
  "namespace": "providerOrders",
  "apiName": "listByOrganization",
  "data": {
    "organizationId": "org_123"
  }
}'

Example Response

{ "status": "ok", "data": {} }

update

Source: backend/endpoints/provider-orders/update

Input Fields

FieldTypeRequired
idstringYes
organizationIdstringYes
patientProfileId*stringNo
sourceType*stringNo
prescriptionId*stringNo
labOrderId*stringNo
appointmentId*stringNo
consultationId*stringNo
items*[]models.ProviderOrderItemNo
subtotal*float64No
status*stringNo
deliveryAddress*models.ProviderOrderDeliveryAddressNo
confirmedAt*int64No
packingAt*int64No
dispatchedAt*int64No
outForDeliveryAt*int64No
deliveredAt*int64No
patientNotes*stringNo
providerNotes*stringNo
razorpayOrderId*stringNo
razorpayPaymentId*stringNo
razorpaySignature*stringNo
paymentStatus*stringNo
amountPaid*float64No
paidAt*int64No
paymentMethod*stringNo
checkoutSessionId*stringNo
createdAt*int64No
updatedAt*int64No

Example Request

curl -X POST https://api.aivida.in/api \
  -H "Content-Type: application/json" \
  -H "x-stack-access-token: <access_token_optional>" \
  -d '{
  "namespace": "providerOrders",
  "apiName": "update",
  "data": {
    "id": "id_123",
    "organizationId": "org_123"
  }
}'

Example Response

{ "status": "ok", "data": {} }