Skip to content
/
Update a service (partial...

Update a service (partial)

Request

Method to partially update a service

Security
BearerPartnerUser
Path
location_idnumberrequired

location ID

service_idnumberrequired

Service ID

Headers
Acceptstringrequired

e.g. application/vnd.api.v2+json

Example:application/vnd.api.v2+json
Content-Typestringrequired

application/json

Authorizationstringrequired

Bearer partner_token, User user_token

Bodyapplication/jsonrequired
titlestringrequired

Service name

Example:"Men's haircut"
category_idnumberrequired

ID service category

Example:83167
price_minnumber, (float)required

Minimum cost of the service

Example:1300
price_maxnumber, (float)required

Maximum cost of the service

Example:1300
durationnumberrequired

Service duration, default value is 3600

Example:3600
booking_titlestringrequired

Service name for appointment

Example:"Men's haircut"
is_multibooleanrequired

false - Appointment, true - Event

Example:false
tax_variantnumberrequired

Bill ID

Example:1
vat_idnumberrequired

VAT ID

Example:3
is_need_limit_datebooleanrequired

The service is available for a limited time

Example:true
seance_search_startnumberrequired

Start of period is the appointment available, in seconds

Example:36000
seance_search_finishnumberrequired

End of period is the appointment available, in seconds

Example:84600
stepnumberrequired

Display interval of slots, in seconds

Example:300
seance_search_stepnumberrequired

Search interval of slots, in seconds

Example:900
technical_break_durationnumber or null
One of:

Technical break duration in seconds.

  • If not provided, defaults to null
  • null = use location default (Settings → Appointment Log → Technical Breaks)
  • Must be in multiples of 300 (5-minute intervals)
  • Maximum value is 3600 (1 hour)
[ 0 .. 3600 ]
number
discountnumber, (float)

Service discount

Example:0
commentstring

Comment on the service

Example:""
date_fromstring, (date)

Service availability start date (YYYY-MM-DD)

Example:"2022-09-19"
date_tostring, (date)

Service availability end date (YYYY-MM-DD)

Example:"2022-09-30"
weightnumber

Service weight (used to sort services when displayed)

Example:6
activenumber

1 - available for online booking, 0 - not available

Example:1
api_idstring

External Service ID

Example:"00000000042"
staffArray of objects

List of team members providing the service and session duration

Example:
[
  {
    "id": 5905,
    "seance_length": 2700
  },
  {
    "id": 5907,
    "seance_length": 3600
  },
  {
    "id": 8973,
    "seance_length": 3600
  },
  {
    "id": 13616,
    "seance_length": 3600
  },
  {
    "id": 16681,
    "seance_length": 3600
  },
  {
    "id": 1796,
    "seance_length": 3600
  },
  {
    "id": 34006,
    "seance_length": 3600
  }
]
curl -i -X PATCH \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/locations/{location_id}/services/{service_id}' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "Men'\''s haircut",
    "booking_title": "Men'\''s haircut",
    "category_id": 83167,
    "price_min": 1300,
    "price_max": 1300,
    "duration": 3600,
    "discount": 0,
    "tax_variant": 1,
    "vat_id": 3,
    "is_multi": false,
    "is_need_limit_date": true,
    "date_from": "2022-09-19",
    "date_to": "2022-09-30",
    "seance_search_start": 36000,
    "seance_search_finish": 84600,
    "step": 300,
    "seance_search_step": 900,
    "comment": "",
    "weight": 6,
    "active": 1,
    "api_id": "00000000042",
    "staff": [
      {
        "id": 5905,
        "seance_length": 2700
      },
      {
        "id": 5907,
        "seance_length": 3600
      },
      {
        "id": 8973,
        "seance_length": 3600
      },
      {
        "id": 13616,
        "seance_length": 3600
      },
      {
        "id": 16681,
        "seance_length": 3600
      },
      {
        "id": 1796,
        "seance_length": 3600
      },
      {
        "id": 34006,
        "seance_length": 3600
      }
    ]
  }'

Responses

OK

Bodyapplication/json
successboolean

Execution success status (true)

Example:true
dataobject
Example:
{
  "title": "Men's haircut",
  "booking_title": "Men's haircut",
  "category_id": 83167,
  "price_min": 1300,
  "price_max": 1300,
  "duration": 3600,
  "discount": 0,
  "tax_variant": 1,
  "vat_id": 3,
  "is_multi": false,
  "is_need_limit_date": true,
  "date_from": "2022-09-19",
  "date_to": "2022-09-30",
  "seance_search_start": 36000,
  "seance_search_finish": 84600,
  "step": 300,
  "seance_search_step": 900,
  "comment": "",
  "weight": 6,
  "active": 1,
  "api_id": "00000000042",
  "staff": [
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … }
  ]
}
metaArray of objects

Metadata (empty array)

Example:
[]
Response
{
  "success": true,
  "data": {
    "booking_title": "Men's haircut",
    "tax_variant": 0,
    "vat_id": 2,
    "print_title": "Men's haircut",
    "service_type": 1,
    "api_service_id": 0,
    "repeat_visit_days_step": "null",
    "seance_search_start": 1800,
    "seance_search_finish": 84600,
    "seance_search_step": 900,
    "step": 300,
    "is_need_limit_date": true,
    "date_from": "2022-09-19",
    "date_to": "2022-09-30",
    "schedule_template_type": 2,
    "online_invoicing_status": 0,
    "is_abonement_autopayment_enabled": 0,
    "autopayment_before_visit_time": 0,
    "abonement_restriction_value": 0,
    "is_chain": false,
    "is_price_managed_only_in_chain": false,
    "is_comment_managed_only_in_chain": false,
    "price_prepaid_amount": 0,
    "price_prepaid_percent": 100,
    "id": 10832934,
    "salon_service_id": 12192004,
    "title": "Men's haircut",
    "category_id": 10832928,
    "price_min": 250,
    "price_max": 1200,
    "discount": 0,
    "comment": "",
    "weight": 0,
    "active": 1,
    "api_id": 0,
    "prepaid": "forbidden",
    "is_multi": false,
    "capacity": 0,
    "image_group": [],
    "staff": [ … ],
    "dates": [ … ],
    "duration": 3600,
    "resources": [],
    "is_online": true
  },
  "meta": []
}