コースの購入

操作ガイド

Amelia API – コース購入

ここでは、コース購入に関連するAPIエンドポイントをご覧いただけます。

すべてのAPIエンドポイントと、リクエストおよびレスポンスの例は、こちらからダウンロードできるAmelia API Postmanコレクションで確認できます。

APIエンドポイントの使用には、一定のコーディングスキルが必要であり、プラグインで提供されるサポートには含まれていません。

読みたいところをタップ

1 認証
2 パス
3 コース購入の追加
4 コース予約の追加
5 コース購入ステータスの更新
6 利用可能なコースの時間枠の取得
7 コース購入の削除

認証

すべてのAmeliaエンドポイントは、Ameliaという名前のヘッダープロパティを使用したAPIキー認証を採用しています。

パス

Amelia APIのパスは以下で始まります：{{your_site_URL}}/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1

コース購入の追加

コース購入を作成します。

メソッド

このエンドポイントはPOSTリクエストを受け付けます。

パス

/packages/customers

必須プロパティ

以下のプロパティは必須です。

キー	タイプ	説明
`packageId`	integer	コースID。
`customerId`	integer	お客様ID。
`notify`	boolean	お客様にこの購入について通知するかどうか。

例：

リクエスト

curl --location 'http://localhost/amelia/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1/packages/customers' \
--header 'Content-Type: application/json' \
--header 'Amelia: qUmkNNOLrWbf28izIgNnZ29O+7gVWL5M+8ySJ8VXq3r0' \
--data '{ "packageId": 14, "customerId": 16, "notify": true }'

レスポンス

{
"message": "Successfully added new package booking.",
"data": {
"packageCustomerId": 115,
"notify": true,
"paymentId": 1154,
"onlyOneEmployee": null
}
}

コース予約の追加

コース購入に予約を追加します。

メソッド

このエンドポイントはPOSTリクエストを受け付けます。

パス

/appointments

必須プロパティ

以下のプロパティは必須です。

キー	タイプ	説明
`bookings`	array	予約の配列。
`serviceId`	integer	サービスID。
`providerId`	integer	スタッフID。
`bookingStart`	string	予約開始の日時。形式：`YYYY-MM-DD HH:mm`。

オプションのプロパティ

キー	タイプ	説明
`notifyParticipants`	integer	お客様に通知するかどうか。使用可能な値：`1`、`0`。
`internalNotes`	string	予約の内部メモ。
`lessonSpace`	string	使用するレッスンルームのID。
`locationId`	integer	場所ID。

例：

リクエスト

curl --location 'http://localhost/amelia/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1/appointments' \
--header 'Content-Type: application/json' \
--header 'Amelia: qUmkNNOLrWbf28izIgNnZ29O+7gVWL5M+8ySJ8VXq3r0' \
--data '{ "serviceId": 1, "providerId": 1, "locationId": 2, "bookings": [ { "customerId": 16, "status": "approved", "duration": 3600, "persons": 1, "extras": [], "customFields": "{\"1\":{\"label\":\"text\",\"value\":\"\",\"type\":\"text\"},\"4\":{\"label\":\"Adresa\",\"value\":\"\",\"type\":\"address\"}}", "packageCustomerService": { "packageCustomer": { "id": 115 } } } ], "bookingStart": "2023-11-22 09:30", "notifyParticipants": 1, "internalNotes": "", "lessonSpace": null }'

レスポンス

{
"message": "Successfully added new appointment",
"data": {
"appointment": {
"id": 851,
"bookings": [
{
"id": 1147,
"customerId": 16,
"customer": null,
"status": "approved",
"extras": [],
"couponId": null,
"price": 23,
"coupon": null,
"customFields": "{\"1\":{\"label\":\"text\",\"value\":\"\",\"type\":\"text\"},\"4\":{\"label\":\"Adresa\",\"value\":\"\",\"type\":\"address\"}}",
"info": null,
"appointmentId": 851,
"persons": 1,
"token": "8c614c916d",
"payments": [],
"utcOffset": null,
"aggregatedPrice": true,
"isChangedStatus": true,
"isLastBooking": null,
"packageCustomerService": {
"id": 179,
"serviceId": null,
"providerId": null,
"locationId": null,
"bookingsCount": null,
"packageCustomer": {
"id": 115,
"packageId": null,
"customerId": null,
"price": null,
"payments": [],
"start": null,
"end": null,
"purchased": null,
"status": null,
"bookingsCount": null,
"couponId": null,
"coupon": null
}
},
"ticketsData": [],
"duration": 3600,
"created": null,
"actionsCompleted": false,
"isUpdated": null
},
...
],
"notifyParticipants": 0,
"internalNotes": null,
"status": "approved",
"serviceId": 1,
"parentId": null,
"providerId": 1,
"locationId": 2,
"provider": null,
"service": null,
"location": null,
"googleCalendarEventId": null,
"googleMeetUrl": null,
"outlookCalendarEventId": null,
"zoomMeeting": null,
"lessonSpace": null,
"bookingStart": "2023-11-22 09:30:00",
"bookingEnd": "2023-11-22 10:30:00",
"type": "appointment",
"isRescheduled": null,
"isFull": null,
"resources": []
},
"recurring": []
}
}

コース購入ステータスの更新

コース購入ステータスを更新します。

メソッド

このエンドポイントはPOSTリクエストを受け付けます。

パス

/packages/customers/{{package_customer_id}}

必須プロパティ

以下のプロパティは必須です。

キー	タイプ	説明
`status`	string	コース購入の新しいステータス。使用可能な値：`approved`（承認済み）、`canceled`（キャンセル済み）

例：

リクエスト

curl --location 'http://localhost/amelia/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1/packages/customers/115' \
--header 'Content-Type: application/json' \
--header 'Amelia: qUmkNNOLrWbf28izIgNnZ29O+7gVWL5M+8ySJ8VXq3r0' \
--data '{ "status": "canceled" }'

レスポンス

{
"message": "Successfully updated package",
"data": {
"packageCustomerId": "115",
"status": "canceled"
}
}

利用可能なコースの時間枠の取得

コース購入で利用可能な時間枠の数を取得します。

メソッド

このエンドポイントはGETリクエストを受け付けます。

パス

/package-purchases/slots

オプションのプロパティ

コース購入をフィルタリングするために、以下のクエリパラメータを使用できます。

キー	タイプ	説明
`packageId`	int	コースのID
`customerId`	int	お客様のID

例：

リクエスト

curl --location 'http://localhost/amelia2/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1/package-purchases/slots&packageId=3&customerId=3' \
--header 'Amelia: s7nC4/uAb0dPHnFevx06GKJGryzFxnVeiCwPNmZRD/a+'

レスポンス

{
"message": "Successfully retrieved available package slots",
"data": [
{
"customerId": 3,
"packages": [
{
"packageId": 3,
"purchases": [
{
"purchase": [
{
"serviceId": 1,
"available": 3,
"total": 4
},
{
"serviceId": 5,
"available": 3,
"total": 4
}
],
"purchased": "2024-03-29 16:42",
"packageCustomerId": 79
}
]
}
]
}
]
}

コース購入の削除

コース購入を削除します。

メソッド

このエンドポイントはPOSTリクエストを受け付けます。

パス

/packages/customers/delete/{{package_customer_id}}

例：

リクエスト

curl --location --request POST 'http://localhost/amelia/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1/packages/customers/delete/115' \
--header 'Amelia: qUmkNNOLrWbf28izIgNnZ29O+7gVWL5M+8ySJ8VXq3r0' \
--data ''

レスポンス

{
"message": "Successfully deleted package purchase.",
"data": {
"packageCustomer": {
"id": 115,
"packageId": 14,
"customerId": 16,
"price": 180,
"payments": [],
"start": "2023-11-06 15:25:58",
"end": null,
"purchased": "2023-11-06 15:25:58",
"status": "canceled",
"bookingsCount": 0,
"couponId": null,
"coupon": null
},
"appointments": {
"updatedAppointments": [
{
"appointment": {
"id": 851,
"bookings": [
{
"id": 1146,
"customerId": 16,
"customer": {
"id": 16,
"firstName": "Amelia",
"lastName": "Test",
"birthday": null,
"email": "amelia@test.com",
"phone": "+381601234567",
"type": "お客様",
"status": "visible",
"note": null,
"zoomUserId": null,
"countryPhoneIso": null,
"externalId": null,
"pictureFullPath": null,
"pictureThumbPath": null,
"translations": null,
"gender": null
},
"status": "canceled",
"extras": [],
"couponId": null,
"price": 23,
"coupon": null,
"customFields": "{\"2\":{\"label\":\"Select1\",\"value\":\"\",\"type\":\"select\"},\"5\":{\"label\":\"text3\",\"value\":\"\",\"type\":\"text\"},\"7\":{\"label\":\"My address\",\"value\":\"\",\"type\":\"address\"},\"9\":{\"label\":\"address4\",\"value\":\"\",\"type\":\"address\"},\"13\":{\"label\":\"file\",\"value\":\"\",\"type\":\"file\"}}",
"info": "{\"firstName\":\"Amelia\",\"lastName\":\"Test\",\"phone\":\"+381601234567\",\"locale\":null,\"timeZone\":null,\"urlParams\":null}",
"appointmentId": 851,
"persons": 1,
"token": null,
"payments": [],
"utcOffset": null,
"aggregatedPrice": true,
"isChangedStatus": false,
"isLastBooking": null,
"packageCustomerService": {
"id": 179,
"serviceId": null,
"providerId": null,
"locationId": null,
"bookingsCount": null,
"packageCustomer": {
"id": null,
"packageId": null,
"customerId": null,
"price": null,
"payments": [],
"start": null,
"end": null,
"purchased": null,
"status": null,
"bookingsCount": null,
"couponId": null,
"coupon": null
}
},
"ticketsData": [],
"duration": 1800,
"created": "2023-11-06 16:33:22",
"actionsCompleted": null,
"isUpdated": null
}
],
"notifyParticipants": 0,
"internalNotes": null,
"status": "canceled",
"serviceId": 1,
"parentId": null,
"providerId": 1,
"locationId": 2,
"provider": {
"id": 1,
"firstName": "Milica",
"lastName": "Employee",
"birthday": null,
"email": "kpop.lover.10000@gmail.com",
"phone": "+381631652656",
"type": "スタッフ",
"status": null,
"note": "note 123345678900",
"zoomUserId": null,
"countryPhoneIso": null,
"externalId": null,
"pictureFullPath": null,
"pictureThumbPath": null,
"translations": null,
"weekDayList": [],
"serviceList": [],
"dayOffList": [],
"specialDayList": [],
"locationId": null,
"googleCalendar": null,
"outlookCalendar": null,
"timeZone": null,
"description": ""
},
"service": {
"id": 1,
"name": "amelia service",
"description": "location address: %location_address%",
"color": "#1788FB",
"price": 20,
"deposit": null,
"depositPayment": null,
"depositPerPerson": null,
"pictureFullPath": null,
"pictureThumbPath": null,
"extras": [],
"coupons": [],
"position": null,
"settings": "{\"payments\":{\"mollie\":{\"enabled\":true},\"paymentLinks\":{\"enabled\":true,\"changeBookingStatus\":false,\"redirectUrl\":null},\"onSite\":true,\"payPal\":{\"enabled\":true},\"stripe\":{\"enabled\":true},\"razorpay\":{\"enabled\":true},\"square\":{\"enabled\":true}},\"zoom\":{\"enabled\":true},\"lessonSpace\":{\"enabled\":true},\"activation\":{\"version\":\"6.7\"},\"general\":{\"minimumTimeRequirementPriorToCanceling\":null}}",
"fullPayment": null,
"minCapacity": 1,
"maxCapacity": 10,
"duration": 1800,
"timeBefore": 1800,
"timeAfter": 1800,
"bringingAnyone": null,
"show": null,
"aggregatedPrice": null,
"status": "visible",
"categoryId": 1,
"category": null,
"priority": [],
"gallery": [],
"recurringCycle": null,
"recurringSub": null,
"recurringPayment": null,
"translations": null,
"minSelectedExtras": null,
"mandatoryExtra": null,
"customPricing": null,
"maxExtraPeople": null,
"limitPerCustomer": null
},
"location": null,
"googleCalendarEventId": null,
"googleMeetUrl": null,
"outlookCalendarEventId": null,
"zoomMeeting": {
"id": 74364614621,
"startUrl": "https://us04web.zoom.us/s/74364614621?zak=eyJ0eXAiOiJKV1QiLCJzdiI6IjAwMDAwMSIsInptX3NrbSI6InptX28ybSIsImFsZyI6IkhTMjU2In0.eyJhdWQiOiJjbGllbnRzbSIsInVpZCI6IlBNUVVXdlVXVEJLMVh6cW11YVM2LUEiLCJpc3MiOiJ3ZWIiLCJzayI6Ijg0OTc4OTYwMzQ5OTI5NjU2NDUiLCJzdHkiOjEwMCwid2NkIjoidXMwNCIsImNsdCI6MCwibW51bSI6Ijc0MzY0NjE0NjIxIiwiZXhwIjoxNjk5MjkyMDcxLCJpYXQiOjE2OTkyODQ4NzEsImFpZCI6Ing4ejhiTG1WUzJLODA0aktOa09lTmciLCJjaWQiOiIifQ.yY74Fe24ABFGBFd775CTVPVB4UPRoLSMBP2CosVpUsw",
"joinUrl": "https://us04web.zoom.us/j/74364614621?pwd=YtkRIn36Ct9mwBF6p99ZbQm8sa3bo7.1"
},
"lessonSpace": null,
"bookingStart": "2023-11-22 09:30:00",
"bookingEnd": "2023-11-22 10:30:00",
"type": "appointment",
"isRescheduled": false,
"isFull": null,
"resources": []
},
"bookingsWithChangedStatus": [
{
"id": 1147,
"customerId": 16,
"customer": {
"id": 16,
"firstName": "Amelia",
"lastName": "Test",
"birthday": null,
"email": "amelia@test.com",
"phone": "+381601234567",
"type": "お客様",
"status": "visible",
"note": null,
"zoomUserId": null,
"countryPhoneIso": null,
"externalId": null,
"pictureFullPath": null,
"pictureThumbPath": null,
"translations": null,
"gender": null
},
"status": "rejected",
"extras": [],
"couponId": null,
"price": 23,
"coupon": null,
"customFields": "{\"1\":{\"label\":\"text\",\"value\":\"\",\"type\":\"text\"},\"4\":{\"label\":\"Adresa\",\"value\":\"\",\"type\":\"address\"}}",
"info": null,
"appointmentId": 851,
"persons": 1,
"token": null,
"payments": [],
"utcOffset": null,
"aggregatedPrice": true,
"isChangedStatus": true,
"isLastBooking": null,
"packageCustomerService": {
"id": 179,
"serviceId": null,
"providerId": null,
"locationId": null,
"bookingsCount": null,
"packageCustomer": {
"id": null,
"packageId": null,
"customerId": null,
"price": null,
"payments": [],
"start": null,
"end": null,
"purchased": null,
"status": null,
"bookingsCount": null,
"couponId": null,
"coupon": null
}
},
"ticketsData": [],
"duration": 3600,
"created": "2023-11-06 16:34:30",
"actionsCompleted": null,
"isUpdated": null,
"skipNotification": true
}
],
"bookingDeleted": true,
"appointmentDeleted": false,
"appointmentStatusChanged": true,
"appointmentRescheduled": false,
"appointmentEmployeeChanged": null,
"appointmentZoomUserChanged": false,
"appointmentZoomUsersLicenced": false
}
],
"deletedAppointments": []
}
}

Amelia API – コース購入

認証

パス

コース購入の追加

コース予約の追加

コース購入ステータスの更新

利用可能なコースの時間枠の取得

コース購入の削除

初期設定 21

フォーム 9

サービス 8

イベント 8

お客様 7

スタッフ 7

連携 11

機能 5

WordPress Hooks 25

API Endpoint 22

JavaScript Hooks 2