diff --git a/docs/index.html b/docs/index.html index 2962dabc..6c9cee6f 100644 --- a/docs/index.html +++ b/docs/index.html @@ -12,367 +12,354 @@ margin: 0; } - -
API docs by Redocly
API docs by Redocly

Booking Shopify Api (1.0.0)

Download OpenAPI specification:Download

jamal Soueidan: jamal@soueidan.com URL: https://github.com/jamalsoueidan License: MIT

User

GET Get user

This endpoint gets user object

-
path Parameters
username
required
string

username

-

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

GET Get all users professions with total count

This endpoint get all users

-

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

GET Get all users

This endpoint get all users

-
query Parameters
nextCursor
string

nextCursor

-
limit
string

limit items (default 10)

-
profession
string

profession like makeup_artist

-
sortOrder
string

asc or desc

-

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

UserSchedule

GET Get user schedule

This endpoint gets user schedule object

-
path Parameters
username
required
string

username

-
scheduleId
required
string

schedule Id

-
locationId
required
string

location id

-

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

Customer

PUT Create or Update user (restricted fields)

This endpoint creates new or updates user

-
path Parameters
customerId
required
string
Request Body schema: application/json
required
Array of strings or string
required
Array of strings or string
username
required
string^[a-zA-Z0-9-_]+$
aboutMe
required
string
shortDescription
required
string
object
Array of strings or string

Responses

Request samples

Content type
application/json
{
  • "professions": [
    ],
  • "specialties": [
    ],
  • "username": "string",
  • "aboutMe": "string",
  • "shortDescription": "string",
  • "social": {
    },
  • "speaks": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

GET Get customer

This endpoint gets customer object

-
path Parameters
customerId
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

GET Get customer status

This endpoint gets customer status

-
path Parameters
customerId
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

PUT Create or Update user (all fields allowed)

This endpoint creates new or updates user

-
path Parameters
customerId
required
string

must be customerId

-
Request Body schema: application/json
customerId
number
yearsExperience
string <number>
Array of strings or string
Array of strings or string
username
string
aboutMe
string
shortDescription
string
gender
string
object
object
Array of strings or string
fullname
string
active
boolean
email
string <email>
phone
string

Responses

Request samples

Content type
application/json
{
  • "customerId": 0,
  • "yearsExperience": "string",
  • "professions": [
    ],
  • "specialties": [
    ],
  • "username": "string",
  • "aboutMe": "string",
  • "shortDescription": "string",
  • "gender": "string",
  • "social": {
    },
  • "images": {},
  • "speaks": [
    ],
  • "fullname": "string",
  • "active": true,
  • "email": "user@example.com",
  • "phone": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

GET Get customer is business

This endpoint return if customer is business or not

-
path Parameters
customerId
required
string

CustomerId from shopify

-

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

CustomerProduct

GET Get products for customer

This endpoint get products for customer

-
path Parameters
customerId
required
string

customerId is needed

-

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": [
    ]
}

GET Get product ids for customer

This endpoint get product ids for customer

-
path Parameters
customerId
required
string

customerId is needed

-

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": [
    ]
}

GET Get product that exist in one of the schedules for customer

This endpoint get product for customer

-
path Parameters
customerId
required
string
productId
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

PUT Upsert product to schedule

This endpoint update product that exist in schedule

-
path Parameters
customerId
required
string
productId
required
string
Request Body schema: application/json
scheduleId
required
string
required
string or number
required
string or number
required
string or number
required
object (CustomerProductNoticePeriod)
required
object (CustomerProductBookingPeriod)
required
Array of objects (CustomerProductLocations)

Responses

Request samples

Content type
application/json
{
  • "scheduleId": "string",
  • "variantId": "string",
  • "duration": "string",
  • "breakTime": "string",
  • "noticePeriod": {
    },
  • "bookingPeriod": {
    },
  • "locations": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

DEL destroy product

This endpoint remove product from schedule for customer

-
path Parameters
customerId
required
string
productId
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

CustomerAvailability

POST get availabilty for customer

This availabilty for customer

-
path Parameters
customerId
required
string

This field for customerId

-
locationId
required
string

This field for locationId

-
Request Body schema: application/json
startDate
required
string
productIds
required
Array of strings
object

Responses

Request samples

Content type
application/json
{
  • "startDate": "string",
  • "productIds": [
    ],
  • "destination": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": [
    ]
}

CustomerBooking

GET Get booking

This endpoint gets booking object

-
path Parameters
customerId
required
string

customerId for the customer

-
orderId
required
string

orderId for the order

-
query Parameters
date
required
string

date for the lineItem (2014-12-12)

-

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

GET Get all bookings for customer

This endpoint get all bookings

-
path Parameters
customerId
required
string

customerId for the customer

-
query Parameters
mode
required
string
Enum: "completed" "upcoming"

either "upcoming", "completed"

-

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": [
    ]
}

CustomerSchedule

POST Create schedule

This endpoint create new schedule

-
path Parameters
customerId
required
string

The ID of the customerId

-
Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

GET Get all schedule for customer

This endpoint get all schedule for customer

-
path Parameters
customerId
required
string

The ID of the customerId

-

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": [
    ]
}

GET Get schedule for customer

This endpoint get schedule for customer

-
path Parameters
customerId
required
string

The ID of the customerId

-
scheduleId
required
string

The ID of the scheduleId

-

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

PUT Update schedule

This endpoint update schedule

-
path Parameters
customerId
required
string

The ID of the customerId

-
scheduleId
required
string

The ID of the scheduleId

-
Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

DEL destroy schedule

This endpoint destroy schedule for customer

-
path Parameters
customerId
required
string

The ID of the customerId

-
scheduleId
required
string

The ID of the scheduleId

-

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

PUT Update schedule slot

This endpoint update schedule slot

-
path Parameters
customerId
required
string

The ID of the customerId

-
scheduleId
required
string

The ID of the scheduleId

-
Request Body schema: application/json
Array
day
required
string (CustomerScheduleSlotDay)
Enum: "monday" "tuesday" "wednesday" "thursday" "friday" "saturday" "sunday"
required
Array of objects (CustomerScheduleSlotInterval)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

Meta

GET Get all professions

This endpoint get all professions

-

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": [
    ]
}

GET Get all specialties

This endpoint get all specialties

-

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": [
    ]
}

CustomerLocation

GET Get all origin locations

This endpoint get all origin locations

-
path Parameters
customerId
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": [
    ]
}

POST Set new default location for user

This endpoint set new default location for user

-
path Parameters
customerId
required
string
locationId
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

GET Get one location from user

This endpoint get one location for user

-
path Parameters
customerId
required
string
locationId
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

POST Remove location from user

This endpoint remove location but does not delete location from db

-
path Parameters
customerId
required
string
locationId
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

POST Add location to user

This endpoint add new location

-
path Parameters
customerId
required
string
locationId
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

PUT Update location

This endpoint update existing location

-
path Parameters
customerId
required
string
locationId
required
string
Request Body schema: application/json
name
string
fullAddress
string
originType
string
Enum: "home" "commercial"
number or string
number or string
number or string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "fullAddress": "string",
  • "originType": "home",
  • "minDistanceForFree": 0,
  • "distanceHourlyRate": 0,
  • "fixedRatePerKm": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

POST Create location origin or destination

This endpoint creates new location

-
path Parameters
customerId
required
string
Request Body schema: application/json
name
required
string
fullAddress
required
string
locationType
required
string
Enum: "origin" "destination"
originType
required
string
Enum: "home" "commercial"
required
number or string
required
number or string
required
number or string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "fullAddress": "string",
  • "locationType": "origin",
  • "originType": "home",
  • "minDistanceForFree": 0,
  • "distanceHourlyRate": 0,
  • "fixedRatePerKm": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

GET Get all locations for user

This endpoint get all locations for user

-
path Parameters
customerId
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": [
    ]
}

Location

GET location coordinates

This endpoint get coordinates object

-
query Parameters
fullAddress
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

GET location validate address

This endpoint validate address

-
query Parameters
name
string
fullAddress
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

GET location travel time

This endpoint gets traval time object

-
query Parameters
origin
string
destination
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

ShippingCalculate

POST get shipping calculate

Request Body schema: application/json
locationId
required
string
required
object

Responses

Request samples

Content type
application/json
{
  • "locationId": "string",
  • "destination": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}
+ " fill="currentColor">

Booking Shopify Api (1.0.0)

Download OpenAPI specification:Download

jamal Soueidan: jamal@soueidan.com URL: https://github.com/jamalsoueidan License: MIT

User

GET Get user

This endpoint gets user object

+
path Parameters
username
required
string

username

+

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

GET Get all users professions with total count

This endpoint get all users

+

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

GET Get all users

This endpoint get all users

+
query Parameters
nextCursor
string

nextCursor

+
limit
string

limit items (default 10)

+
profession
string

profession like makeup_artist

+
sortOrder
string

asc or desc

+

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

UserSchedule

GET Get user schedule

This endpoint gets user schedule object

+
path Parameters
username
required
string

username

+
scheduleId
required
string

schedule Id

+
locationId
required
string

location id

+

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

Customer

PUT Create or Update user (restricted fields)

This endpoint creates new or updates user

+
path Parameters
customerId
required
string
Request Body schema: application/json
required
required
Array of strings or string
required
Array of strings or string
username
required
string^[a-zA-Z0-9-_]+$
aboutMe
required
string
shortDescription
required
string
object
Array of strings or string

Responses

Request samples

Content type
application/json
{
  • "professions": [
    ],
  • "specialties": [
    ],
  • "username": "string",
  • "aboutMe": "string",
  • "shortDescription": "string",
  • "social": {
    },
  • "speaks": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

GET Get customer

This endpoint gets customer object

+
path Parameters
customerId
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

GET Get customer status

This endpoint gets customer status

+
path Parameters
customerId
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

PUT Create or Update user (all fields allowed)

This endpoint creates new or updates user

+
path Parameters
customerId
required
string

must be customerId

+
Request Body schema: application/json
required
customerId
number
yearsExperience
string <number>
Array of strings or string
Array of strings or string
username
string
aboutMe
string
shortDescription
string
gender
string
object
object
Array of strings or string
fullname
string
active
boolean
email
string <email>
phone
string

Responses

Request samples

Content type
application/json
{
  • "customerId": 0,
  • "yearsExperience": "string",
  • "professions": [
    ],
  • "specialties": [
    ],
  • "username": "string",
  • "aboutMe": "string",
  • "shortDescription": "string",
  • "gender": "string",
  • "social": {
    },
  • "images": {},
  • "speaks": [
    ],
  • "fullname": "string",
  • "active": true,
  • "email": "user@example.com",
  • "phone": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

GET Get customer is business

This endpoint return if customer is business or not

+
path Parameters
customerId
required
string

CustomerId from shopify

+

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

CustomerProduct

GET Get products for customer

This endpoint get products for customer

+
path Parameters
customerId
required
string

customerId is needed

+

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": [
    ]
}

GET Get product ids for customer

This endpoint get product ids for customer

+
path Parameters
customerId
required
string

customerId is needed

+

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": [
    ]
}

GET Get product that exist in one of the schedules for customer

This endpoint get product for customer

+
path Parameters
customerId
required
string
productId
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

PUT Upsert product to schedule

This endpoint update product that exist in schedule

+
path Parameters
customerId
required
string
productId
required
string
Request Body schema: application/json
required
scheduleId
required
string
required
string or number
required
string or number
required
string or number
required
object (CustomerProductNoticePeriod)
required
object (CustomerProductBookingPeriod)
required
Array of objects (CustomerProductLocations)

Responses

Request samples

Content type
application/json
{
  • "scheduleId": "string",
  • "variantId": "string",
  • "duration": "string",
  • "breakTime": "string",
  • "noticePeriod": {
    },
  • "bookingPeriod": {
    },
  • "locations": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

DEL destroy product

This endpoint remove product from schedule for customer

+
path Parameters
customerId
required
string
productId
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

CustomerAvailability

POST get availabilty for customer

This availabilty for customer

+
path Parameters
customerId
required
string

This field for customerId

+
locationId
required
string

This field for locationId

+
Request Body schema: application/json
required
startDate
required
string
productIds
required
Array of strings
object

Responses

Request samples

Content type
application/json
{
  • "startDate": "string",
  • "productIds": [
    ],
  • "destination": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": [
    ]
}

CustomerBooking

GET Get booking

This endpoint gets booking object

+
path Parameters
customerId
required
string

customerId for the customer

+
orderId
required
string

orderId for the order

+
query Parameters
date
required
string

date for the lineItem (2014-12-12)

+

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

GET Get all bookings for customer

This endpoint get all bookings

+
path Parameters
customerId
required
string

customerId for the customer

+
query Parameters
mode
required
string
Enum: "completed" "upcoming"

either "upcoming", "completed"

+

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": [
    ]
}

CustomerSchedule

POST Create schedule

This endpoint create new schedule

+
path Parameters
customerId
required
string

The ID of the customerId

+
Request Body schema: application/json
required
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

GET Get all schedule for customer

This endpoint get all schedule for customer

+
path Parameters
customerId
required
string

The ID of the customerId

+

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": [
    ]
}

GET Get schedule for customer

This endpoint get schedule for customer

+
path Parameters
customerId
required
string

The ID of the customerId

+
scheduleId
required
string

The ID of the scheduleId

+

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

PUT Update schedule

This endpoint update schedule

+
path Parameters
customerId
required
string

The ID of the customerId

+
scheduleId
required
string

The ID of the scheduleId

+
Request Body schema: application/json
required
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

DEL destroy schedule

This endpoint destroy schedule for customer

+
path Parameters
customerId
required
string

The ID of the customerId

+
scheduleId
required
string

The ID of the scheduleId

+

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

PUT Update schedule slot

This endpoint update schedule slot

+
path Parameters
customerId
required
string

The ID of the customerId

+
scheduleId
required
string

The ID of the scheduleId

+
Request Body schema: application/json
required
Array
day
required
string (CustomerScheduleSlotDay)
Enum: "monday" "tuesday" "wednesday" "thursday" "friday" "saturday" "sunday"
required
Array of objects (CustomerScheduleSlotInterval)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

Meta

GET Get all professions

This endpoint get all professions

+

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": [
    ]
}

GET Get all specialties

This endpoint get all specialties

+

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": [
    ]
}

CustomerLocation

GET Get all origin locations

This endpoint get all origin locations

+
path Parameters
customerId
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": [
    ]
}

POST Set new default location for user

This endpoint set new default location for user

+
path Parameters
customerId
required
string
locationId
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

GET Get one location from user

This endpoint get one location for user

+
path Parameters
customerId
required
string
locationId
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

POST Remove location from user

This endpoint remove location but does not delete location from db

+
path Parameters
customerId
required
string
locationId
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

POST Add location to user

This endpoint add new location

+
path Parameters
customerId
required
string
locationId
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

PUT Update location

This endpoint update existing location

+
path Parameters
customerId
required
string
locationId
required
string
Request Body schema: application/json
required
name
string
fullAddress
string
originType
string
Enum: "home" "commercial"
number or string
number or string
number or string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "fullAddress": "string",
  • "originType": "home",
  • "minDistanceForFree": 0,
  • "distanceHourlyRate": 0,
  • "fixedRatePerKm": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

POST Create location origin or destination

This endpoint creates new location

+
path Parameters
customerId
required
string
Request Body schema: application/json
required
name
required
string
fullAddress
required
string
locationType
required
string
Enum: "origin" "destination"
originType
required
string
Enum: "home" "commercial"
required
number or string
required
number or string
required
number or string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "fullAddress": "string",
  • "locationType": "origin",
  • "originType": "home",
  • "minDistanceForFree": 0,
  • "distanceHourlyRate": 0,
  • "fixedRatePerKm": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

GET Get all locations for user

This endpoint get all locations for user

+
path Parameters
customerId
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": [
    ]
}

Location

GET location coordinates

This endpoint get coordinates object

+
query Parameters
fullAddress
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

GET location validate address

This endpoint validate address

+
query Parameters
name
string
fullAddress
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

GET location travel time

This endpoint gets traval time object

+
query Parameters
origin
string
destination
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}

ShippingCalculate

POST get shipping calculate

Request Body schema: application/json
required
locationId
required
string
required
object

Responses

Request samples

Content type
application/json
{
  • "locationId": "string",
  • "destination": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    }
}