Amelia API – Package Purchases

Here you can see API endpoints related to package purchases.

You can see all the API endpoints with examples of requests and responses in the Amelia API Postman collection which you can download here.

Content

Add package purchase

Add package appointment

Update package purchase status

Delete package purchase

Please note: The API Endpoints are included only in the Developer license plans. Using API Endpoints requires a certain level of coding skills, and is not included in the provided support for the plugin.

Authorization

All Amelia endpoints use an API key authorization, using the header property named “Amelia”.

Path

Amelia API paths start with: {{your_site_URL}}/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1

Add package purchase

Create a package purchase.

Method

This endpoint accepts POST requests.

Path

/packages/customers

Required Properties

The following properties are required.

Key	Type	Description
packageId	integer	The package id.
customerId	integer	The customer id.
notify	boolean	Whether the customer will be notified about this purchase.

Example

Request

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
}'

Response

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

Add package appointment

Add an appointment to a package purchase.

Method

This endpoint accepts POST requests.

Path

/appointments

Required Properties

The following properties are required.

Key	Type	Description
bookings	array	An array of booking.
serviceId	integer	The service id.
providerId	integer	The employee id.
bookingStart	string	The date and time of the start of the appointment. The format is: “YYYY-MM-DD HH:mm”.

Optional Properties

Key	Type	Description
notifyParticipants	integer	Whether the customer should be notified. Possible values: 1, 0.
internalNotes	string	The internal notes of the appointment.
lessonSpace	string	The id of the lesson space room to be used.
locationId	integer	The location id.

Example

Request

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
}'

Response

{
    "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
                },
                {
                    "id": 1146,
                    "customerId": 16,
                    "customer": 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": null,
                    "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": "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": []
    }
}

Update package purchase status

Update package purchase status.

Method

This endpoint accepts POST requests.

Path

/packages/customers/{{package_customer_id}}

Required Properties

The following properties are required.

Key	Type	Description
status	string	The new status of the package pucrhase. Possible values: “approved”, “canceled”

Example

Request

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" 
}'

Response

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

Delete a package purchase

Delete a package purchase.

Method

This endpoint accepts POST requests.

Path

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

Example

Request

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 ''

Response

{
    "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": "[email protected]",
                                    "phone": "+381601234567",
                                    "type": "customer",
                                    "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": "[email protected]",
                            "phone": "+381631652656",
                            "type": "provider",
                            "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": "[email protected]",
                                "phone": "+381601234567",
                                "type": "customer",
                                "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 – Packages Amelia API – Resources

Cookie	Duration	Description
__cfduid	1 month	The cookie is used by cdn services like CloudFlare to identify individual clients behind a shared IP address and apply security settings on a per-client basis. It does not correspond to any user ID in the web application and does not store any personally identifiable information.
ac_enable_tracking	1 month	This cookie is set by the Active Campaign. This cookie is used to keep track of the site usage.
cookielawinfo-checkbox-analytics	11 months	This cookie is set by GDPR Cookie Consent plugin. The cookie is used to store the user consent for the cookies in the category "Analytics".
cookielawinfo-checkbox-functional	11 months	The cookie is set by GDPR cookie consent to record the user consent for the cookies in the category "Functional".
cookielawinfo-checkbox-necessary	11 months	This cookie is set by GDPR Cookie Consent plugin. The cookies is used to store the user consent for the cookies in the category "Necessary".
cookielawinfo-checkbox-others	11 months	This cookie is set by GDPR Cookie Consent plugin. The cookie is used to store the user consent for the cookies in the category "Other.
cookielawinfo-checkbox-performance	11 months	This cookie is set by GDPR Cookie Consent plugin. The cookie is used to store the user consent for the cookies in the category "Performance".
viewed_cookie_policy	11 months	The cookie is set by the GDPR Cookie Consent plugin and is used to store whether or not user has consented to the use of cookies. It does not store any personal data.

Cookie	Duration	Description
_ga	2 years	This cookie is installed by Google Analytics. The cookie is used to calculate visitor, session, campaign data and keep track of site usage for the site's analytics report. The cookies store information anonymously and assign a randomly generated number to identify unique visitors.
_gat_UA-120126744-1	1 minute	This is a pattern type cookie set by Google Analytics, where the pattern element on the name contains the unique identity number of the account or website it relates to. It appears to be a variation of the _gat cookie which is used to limit the amount of data recorded by Google on high traffic volume websites.
_gcl_au	3 months	This cookie is used by Google Analytics to understand user interaction with the website.
_gid	1 day	This cookie is installed by Google Analytics. The cookie is used to store information of how visitors use a website and helps in creating an analytics report of how the website is doing. The data collected including the number visitors, the source where they have come from, and the pages visted in an anonymous form.
_ym_d	1 year	This domain of this cookie is owned by Yandex.Matrica. This cookie is used to store the date of the users first site session.
_ym_isad	20 hours	This domain of this cookie is owned by Yandex.Matrica. This cookie is used to collect information about the user like his characteristics, behaviour on page and targeted actions.
_ym_uid	1 year	This cookie is by Yandex.Metrica. This cookie is used to set a unique ID to the visitor and to collect information about how visitor use the website. Thus it help to track the user and the collected informationn is used to improve the site.
yabs-sid	session	These are cookies used by Yandex Matrica script belonging to the company Yandex. This cookies are used to measure and analyse the traffic of the website by giving information about how the users use the website.
yandexuid	1 year	This cookie is used to identify the users. This cookie collects information about how visitors use the website. This information is used for internal analysis and site optimization.
ymex	1 year	This cookie is set by yandex. This cookie is used to collect information about the user behaviour on the website. This information is used for website analysis and for website optimisation.

Cookie	Duration	Description
_fbp	3 months	This cookie is set by Facebook to deliver advertisement when they are on Facebook or a digital platform powered by Facebook advertising after visiting this website.
fr	3 months	The cookie is set by Facebook to show relevant advertisments to the users and measure and improve the advertisements. The cookie also tracks the behavior of the user across the web on sites that have Facebook pixel or Facebook social plugin.
i	10 years	The purpose of the cookie is not known yet.
IDE	1 year 24 days	Used by Google DoubleClick and stores information about how the user uses the website and any other advertisement before visiting the website. This is used to present users with ads that are relevant to them according to the user profile.
test_cookie	15 minutes	This cookie is set by doubleclick.net. The purpose of the cookie is to determine if the user's browser supports cookies.
VISITOR_INFO1_LIVE	5 months 27 days	This cookie is set by Youtube. Used to track the information of the embedded YouTube videos on a website.
YSC	session	This cookies is set by Youtube and is used to track the views of embedded videos.

Cookie	Duration	Description
CONSENT	16 years 6 months	No description
metrika_enabled	session	No description available.
paddle_session	2 hours	No description available.
prism_610072376	1 month	No description available.
wp-wpml_current_language	1 day	No description available.
yt-remote-connected-devices	never	No description available.
yt-remote-device-id	never	No description available.
yuidss	1 year	No description available.