Provider Orders
Function-calling namespace: providerOrders
- Base URL:
https://api.aivida.in - Engine endpoint:
POST /api - Auth: Stack token middleware enabled in
optionalmode. - Send token in header:
x-stack-access-token: <access_token>(orAuthorization: Bearer <access_token>). - In
optionalmode: no token is allowed; invalid token is rejected with401.
create
Source: backend/endpoints/provider-orders/create
Input Fields
| Field | Type | Required |
|---|---|---|
patientProfileId | string | Yes |
organizationId | string | Yes |
sourceType | string | Yes |
prescriptionId | string | No |
labOrderId | string | No |
appointmentId | string | No |
consultationId | string | No |
items | []models.ProviderOrderItem | Yes |
subtotal | float64 | No |
status | string | Yes |
deliveryAddress | *models.ProviderOrderDeliveryAddress | No |
confirmedAt | *int64 | No |
packingAt | *int64 | No |
dispatchedAt | *int64 | No |
outForDeliveryAt | *int64 | No |
deliveredAt | *int64 | No |
patientNotes | string | No |
providerNotes | string | No |
razorpayOrderId | string | No |
razorpayPaymentId | string | No |
razorpaySignature | string | No |
paymentStatus | string | No |
amountPaid | *float64 | No |
paidAt | *int64 | No |
paymentMethod | string | No |
checkoutSessionId | string | No |
createdAt | *int64 | No |
updatedAt | *int64 | No |
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
| Field | Type | Required |
|---|---|---|
id | string | Yes |
organizationId | string | Yes |
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
| Field | Type | Required |
|---|---|---|
id | string | Yes |
organizationId | string | Yes |
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
| Field | Type | Required |
|---|---|---|
organizationId | string | Yes |
page | int | No |
pageSize | int | No |
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
| Field | Type | Required |
|---|---|---|
id | string | Yes |
organizationId | string | Yes |
patientProfileId | *string | No |
sourceType | *string | No |
prescriptionId | *string | No |
labOrderId | *string | No |
appointmentId | *string | No |
consultationId | *string | No |
items | *[]models.ProviderOrderItem | No |
subtotal | *float64 | No |
status | *string | No |
deliveryAddress | *models.ProviderOrderDeliveryAddress | No |
confirmedAt | *int64 | No |
packingAt | *int64 | No |
dispatchedAt | *int64 | No |
outForDeliveryAt | *int64 | No |
deliveredAt | *int64 | No |
patientNotes | *string | No |
providerNotes | *string | No |
razorpayOrderId | *string | No |
razorpayPaymentId | *string | No |
razorpaySignature | *string | No |
paymentStatus | *string | No |
amountPaid | *float64 | No |
paidAt | *int64 | No |
paymentMethod | *string | No |
checkoutSessionId | *string | No |
createdAt | *int64 | No |
updatedAt | *int64 | No |
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": {} }