Skip to main content
POST
/
shops
/
{shopId}
/
services
Create a new service
curl --request POST \
  --url https://api.guile.app/shops/{shopId}/services \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Skin Fade",
  "visibility": "visible",
  "bundledAddOns": [
    {
      "id": "service-123",
      "name": "Beard Trim"
    }
  ],
  "categories": [
    {
      "id": "afada02b-e9fe",
      "name": "Shaving"
    }
  ],
  "description": "Expertly transitioned fade with optional designs on the side.",
  "duration": "PT30M",
  "cost": "45.00",
  "addOn": {
    "duration": "PT30M",
    "cost": "45.00"
  },
  "ageRestrictions": {
    "min": 18,
    "max": 100
  }
}
'
{
  "name": "Skin Fade",
  "visibility": "visible",
  "bundledAddOns": [
    {
      "id": "service-123",
      "name": "Beard Trim"
    }
  ],
  "categories": [
    {
      "id": "afada02b-e9fe",
      "name": "Shaving"
    }
  ],
  "description": "Expertly transitioned fade with optional designs on the side.",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "duration": "PT30M",
  "cost": "45.00",
  "addOn": {
    "duration": "PT30M",
    "cost": "45.00"
  },
  "ageRestrictions": {
    "min": 18,
    "max": 100
  }
}

Path Parameters

ā€‹
shopId
string<uuid>
required

The unique, opaque system identifier for a resource. This case-sensitive ID is also used as path parameters in URLs or in other properties or parameters that reference a resource by ID rather than URL.

Body

application/json

Properties for creating a new service for a barber.

A service can be configured as a base service, add-on, or bundle. When configured as a bundle, the service cannot be configured as an add-on or included in another bundle.

Services that are not bundles and have configurations for being used as a base service, an add-on, or both.

ā€‹
name
string
required

The display name for this service.

Example:

"Skin Fade"

ā€‹
visibility
enum<string>
required

The visibility of the service. Hidden services are not visible to customers.

Available options:
visible,
hidden
ā€‹
bundledAddOns
object[]
required

Additional add-on services included in this service bundle.

Example:
[
  { "id": "service-123", "name": "Beard Trim" }
]
ā€‹
categories
object[]
required

The categories for this service.

Example:
[
  { "id": "afada02b-e9fe", "name": "Shaving" }
]
ā€‹
description
string
required

The description of this service.

Maximum string length: 500
Example:

"Expertly transitioned fade with optional designs on the side."

ā€‹
duration
string<duration>

The duration of the service.

Example:

"PT30M"

ā€‹
cost
string<decimal>

The cost of the service, excluding any fees or taxes.

Example:

"45.00"

ā€‹
addOn
object

If set, the configuration for this service when used as an add-on.

ā€‹
ageRestrictions
object

The age restrictions, if any, for this service.

Response

Created.

Representation of a service performed by a barber.

ā€‹
name
string
required

The display name for this service.

Example:

"Skin Fade"

ā€‹
visibility
enum<string>
required

The visibility of the service. Hidden services are not visible to customers.

Available options:
visible,
hidden
ā€‹
bundledAddOns
object[]
required

Additional add-on services included in this service bundle.

Example:
[
  { "id": "service-123", "name": "Beard Trim" }
]
ā€‹
categories
object[]
required

The categories for this service.

Example:
[
  { "id": "afada02b-e9fe", "name": "Shaving" }
]
ā€‹
description
string
required

The description of this service.

Maximum string length: 500
Example:

"Expertly transitioned fade with optional designs on the side."

ā€‹
id
string<uuid>
required

The unique identifier for this service.

ā€‹
createdAt
string<date-time>
required

The date-time when this resource was created, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. This is derived and immutable.

ā€‹
updatedAt
string<date-time>
required

The date-time when this resource was updated, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. This is derived and immutable.

ā€‹
duration
string<duration>

The duration of the service.

Example:

"PT30M"

ā€‹
cost
string<decimal>

The cost of the service, excluding any fees or taxes.

Example:

"45.00"

ā€‹
addOn
object

If set, the configuration for this service when used as an add-on.

ā€‹
ageRestrictions
object

The age restrictions, if any, for this service.