Agendize Developers API

Agendize discounts API

Queues

Resource representation

{ "id": {string}, "name": {string}, type: {string}, "details": [ { "id": {string}, "value": {integer}, "order": {string}, "company": { "id": {string}, "name": {string}, "selfLink": {string} }, "service": { "id": {string}, "name": {string}, "selfLink": {string} }, "resource": { "id": {string}, "name": {string}, "selfLink": {string} } } ], updated: { "dateTime": {string}, "timeZone": {string} } }
Parameter name Value Description
id string Identifier of the discount.
name string Name of the discount. Writable. Max length: 255
duration string Duration of the discount, in seconds
type string Type of discount. Values: "percentage", "fixedAmount". Writable.
details list Details list of the discount.
details[].order integer Priority order of the discount details. Writable.
details[].company object Company linked with discount details.
details[].company.id string Identifier of the company. Writable.
details[].company.name string Name of the company.
details[].company.selfLink string API link to the company.
details[].service object Service linked with discount details.
details[].service.id string Identifier of the service. Writable.
details[].service.name string Name of the service.
details[].service.selfLink string API link to the service.
details[].resource object Resource linked with discount details.
details[].resource.id string Identifier of the resource. Writable.
details[].resource.name string Name of the resource.
details[].resource.selfLink string API link to the resource.

Delete

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

DELETE https://api.agendize.com/api/2.0/discounts/{discountId}

Parameters

Parameter name Value Description
Path parameters
discountId string Discount identifier.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns an empty response body.

Get

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

GET https://api.agendize.com/api/2.0/discounts/{discountId}

Parameters

Parameter name Value Description
Path parameters
discountId string discount identifier.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a Discount resource in the response body.

List

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

GET https://api.agendize.com/api/2.0/discounts

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure:

{ items: [Discount Resource] }

Insert

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

POST https://api.agendize.com/api/2.0/discounts

Request body

In the request body, supply a Discount Resource with the following properties:

Parameter name Value Description
Required Properties
name string Name of the queue.

Response

If successful, this method returns a Discount resource in the response body.

Update

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

PUT https://api.agendize.com/api/2.0/discounts/{discountId}

Parameters

Parameter name Value Description
Path parameters
discountId string Queue identifier.

Request body

In the request body, supply a Discount resource with the following properties:

Parameter name Value Description
Optional Properties

Response

If successful, this method returns a Discount resource in the response body.

Agendize | Support | Status

Last update: Mar 18, 2024 - Copyright © 2024 Agendize. All rights reserved.