Skip to main content
POST
/
admin
/
shops
Create a shop profile
curl --request POST \
  --url https://api.guile.app/admin/shops \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com",
  "phoneNumber": "<string>",
  "address": {
    "address1": "<string>",
    "locality": "Atlanta",
    "regionCode": "VT",
    "postalCode": "20521-9000",
    "countryCode": "CA",
    "address2": "<string>"
  }
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email": "jsmith@example.com",
  "phoneNumber": "<string>",
  "address": {
    "address1": "<string>",
    "locality": "Atlanta",
    "regionCode": "VT",
    "postalCode": "20521-9000",
    "countryCode": "CA",
    "address2": "<string>"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Body

application/json

Properties required to create a shop profile.

​
email
string<email>
required

The shop's email address.

Required string length: 6 - 255
Pattern: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$
​
phoneNumber
string<phone>
required

The shop's phone number.

Required string length: 6 - 20
Pattern: ^\+?[0-9]{1,3}?[ -]?\(?[0-9]{1,4}?\)?[ -]?[0-9]{1,4}?[ -]?[0-9]{1,4}?[ -]?[0-9]{1,9}$
​
address
object
required

The postal address of the shop location.

Response

Created.

A representation of a shop profile.

​
id
string<uuid>
required

The unique identifier of the shop profile.

​
email
string<email>
required

The shop's email address.

Required string length: 6 - 255
Pattern: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$
​
phoneNumber
string<phone>
required

The shop's phone number.

Required string length: 6 - 20
Pattern: ^\+?[0-9]{1,3}?[ -]?\(?[0-9]{1,4}?\)?[ -]?[0-9]{1,4}?[ -]?[0-9]{1,4}?[ -]?[0-9]{1,9}$
​
address
object
required

The postal address of the shop location.

​
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.