diff --git a/docs/index.html b/docs/index.html index 16dbe1fc..4863a7e0 100644 --- a/docs/index.html +++ b/docs/index.html @@ -351,7 +351,7 @@ -
API docs by Redocly
API docs by Redocly

Forbidden

Response samples

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

UserProduct

GET Get products for user

Response samples

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

UserProduct

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

This endpoint get product for customer

+
path Parameters
username
required
string
productId
required
string

Responses

Response samples

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

GET Get products for user

This endpoint get products for user (across all schedules or one scheduleId)

path Parameters
username
required
string

username is needed

@@ -459,7 +471,7 @@ " class="sc-iJuWdM sc-cBNeRQ gpkGbA casAkG sc-citwID bzkUsW">

Unauthorized

Response samples

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

GET Get products for user

Response samples

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

GET Get products for user

This endpoint is intended to be used when we need to fetch related products from the same schedule and same location.

path Parameters
username
required
string

username is needed

@@ -475,7 +487,7 @@ " class="sc-iJuWdM sc-cBNeRQ gpkGbA casAkG sc-citwID bzkUsW">

Unauthorized

Response samples

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

GET Get products for user

Response samples

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

GET Get products for user

This endpoint get products in productsId from one schedule by location

path Parameters
username
required
string

username is needed

@@ -489,7 +501,7 @@ " class="sc-iJuWdM sc-cBNeRQ gpkGbA casAkG sc-citwID bzkUsW">

Unauthorized

Request samples

Content type
application/json
{
  • "productIds": [
    ]
}

Response samples

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

UserSchedule

GET Get user schedule

Request samples

Content type
application/json
{
  • "productIds": [
    ]
}

Response samples

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

UserSchedule

GET Get user schedule

This endpoint should retrieve a schedule and locations belonging to a specific productId, along with the product.

path Parameters
username
required
string

username

@@ -505,7 +517,7 @@ " class="sc-iJuWdM sc-cBNeRQ gpkGbA casAkG sc-citwID bzkUsW">

Forbidden

Response samples

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

GET Get schedules for user

Response samples

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

GET Get schedules for user

This endpoint should return all locations present in all schedules for specific user

path Parameters
username
required
string

username is needed

@@ -517,7 +529,7 @@ " class="sc-iJuWdM sc-cBNeRQ gpkGbA casAkG sc-citwID bzkUsW">

Unauthorized

Response samples

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

GET Get user schedule

Response samples

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

GET Get user schedule

This endpoint should retrieve a schedule with products that only belong to a specific locationId.

path Parameters
username
required
string

username

@@ -535,7 +547,7 @@ " class="sc-iJuWdM sc-cBNeRQ gpkGbA casAkG sc-citwID bzkUsW">

Forbidden

Response samples

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

UserLocation

GET Get one location from user

Response samples

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

UserLocation

GET Get one location from user

This endpoint get one location for user

path Parameters
username
required
string
locationId
required
string

Responses

Response samples

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

UserAvailability

POST generate availabilty for user

Response samples

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

UserAvailability

POST generate availabilty for user

This endpoint generate availabilty for user

path Parameters
username
required
string

This field for username

@@ -561,7 +573,7 @@ " class="sc-iJuWdM sc-cBNeRQ gpkGbA casAkG sc-citwID bzkUsW">

Unauthorized

Request samples

Content type
application/json
{
  • "fromDate": "string",
  • "productIds": [
    ],
  • "shippingId": "string"
}

Response samples

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

POST get single availabilty for user

Request samples

Content type
application/json
{
  • "fromDate": "string",
  • "productIds": [
    ],
  • "shippingId": "string"
}

Response samples

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

POST get single availabilty for user

This endpoint get's one single availabilty for user

path Parameters
username
required
string

This field for username

@@ -575,7 +587,7 @@ " class="sc-iJuWdM sc-cBNeRQ gpkGbA casAkG sc-citwID bzkUsW">

Unauthorized

Request samples

Content type
application/json
{
  • "fromDate": "string",
  • "toDate": "string",
  • "productIds": [
    ],
  • "shippingId": "string"
}

Response samples

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

Customer

PUT Create or Update user (restricted fields)

Request samples

Content type
application/json
{
  • "fromDate": "string",
  • "toDate": "string",
  • "productIds": [
    ],
  • "shippingId": "string"
}

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

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

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)

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

@@ -621,7 +633,7 @@ " class="sc-iJuWdM sc-cBNeRQ gpkGbA casAkG sc-citwID bzkUsW">

Unauthorized

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

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

@@ -635,7 +647,7 @@ " class="sc-iJuWdM sc-cBNeRQ gpkGbA casAkG sc-citwID bzkUsW">

Forbidden

Response samples

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

CustomerProduct

GET Get products for customer

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

@@ -647,7 +659,7 @@ " class="sc-iJuWdM sc-cBNeRQ gpkGbA casAkG sc-citwID bzkUsW">

Unauthorized

Response samples

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

GET Get product ids for customer

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

@@ -659,7 +671,7 @@ " class="sc-iJuWdM sc-cBNeRQ gpkGbA casAkG sc-citwID bzkUsW">

Unauthorized

Response samples

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

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

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

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
variantId
required
number
required
object
required
object
object
duration
required
number
breakTime
required
number
required
object (CustomerProductNoticePeriod)
required
object (CustomerProductBookingPeriod)
required
Array of objects (CustomerProductLocations)

Responses

Request samples

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

Response samples

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

DEL destroy product

Request samples

Content type
application/json
{
  • "scheduleId": "string",
  • "variantId": 0,
  • "selectedOptions": {
    },
  • "price": {
    },
  • "compareAtPrice": {
    },
  • "duration": 0,
  • "breakTime": 0,
  • "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": {
    }
}

CustomerBooking

GET Get booking

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

@@ -713,7 +725,7 @@ " class="sc-iJuWdM sc-cBNeRQ gpkGbA casAkG sc-citwID bzkUsW">

Forbidden

Response samples

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

GET Get all bookings for customer

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

@@ -729,7 +741,7 @@ " class="sc-iJuWdM sc-cBNeRQ gpkGbA casAkG sc-citwID bzkUsW">

Forbidden

Response samples

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

CustomerSchedule

POST Create schedule

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

@@ -743,7 +755,7 @@ " class="sc-iJuWdM sc-cBNeRQ gpkGbA casAkG sc-citwID bzkUsW">

Forbidden

Request samples

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

Response samples

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

GET Get all schedule for customer

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

@@ -755,7 +767,7 @@ " class="sc-iJuWdM sc-cBNeRQ gpkGbA casAkG sc-citwID bzkUsW">

Unauthorized

Response samples

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

GET Get schedule for customer

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

@@ -771,7 +783,7 @@ " class="sc-iJuWdM sc-cBNeRQ gpkGbA casAkG sc-citwID bzkUsW">

Forbidden

Response samples

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

PUT Update schedule

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

@@ -787,7 +799,7 @@ " class="sc-iJuWdM sc-cBNeRQ gpkGbA casAkG sc-citwID bzkUsW">

Forbidden

Request samples

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

Response samples

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

DEL destroy schedule

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

@@ -801,7 +813,7 @@ " class="sc-iJuWdM sc-cBNeRQ gpkGbA casAkG sc-citwID bzkUsW">

Unauthorized

Response samples

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

PUT Update schedule slot

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

@@ -817,7 +829,7 @@ " class="sc-iJuWdM sc-cBNeRQ gpkGbA casAkG sc-citwID bzkUsW">

Forbidden

Request samples

Content type
application/json
{
  • "slots": [
    ]
}

Response samples

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

Meta

GET Get all professions

Request samples

Content type
application/json
{
  • "slots": [
    ]
}

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

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

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

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

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

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

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

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
required
string
fullAddress
required
string
originType
required
string
Enum: "home" "commercial"
distanceForFree
required
number
distanceHourlyRate
required
number
fixedRatePerKm
required
number
minDriveDistance
required
number
maxDriveDistance
required
number
startFee
required
number

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "fullAddress": "string",
  • "originType": "home",
  • "distanceForFree": 0,
  • "distanceHourlyRate": 0,
  • "fixedRatePerKm": 0,
  • "minDriveDistance": 0,
  • "maxDriveDistance": 0,
  • "startFee": 0
}

Response samples

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

POST Create location origin or destination

Request samples

Content type
application/json
{
  • "name": "string",
  • "fullAddress": "string",
  • "originType": "home",
  • "distanceForFree": 0,
  • "distanceHourlyRate": 0,
  • "fixedRatePerKm": 0,
  • "minDriveDistance": 0,
  • "maxDriveDistance": 0,
  • "startFee": 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
originType
required
string
Enum: "home" "commercial"
distanceForFree
required
number
distanceHourlyRate
required
number
fixedRatePerKm
required
number
minDriveDistance
required
number
maxDriveDistance
required
number
startFee
required
number
locationType
required
string
Enum: "origin" "destination"

Responses

Request samples

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

Response samples

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

GET Get all locations for user

Request samples

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

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

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

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

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": {
    }
}

ShippingCreate

POST create shipping

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

Responses

Response samples

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

ShippingCreate

POST create shipping

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

Responses

Request samples

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

Response samples

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

ShippingCalculate

POST get shipping calculate

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

Responses

Request samples

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

Response samples

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

ShippingCalculate

POST get shipping calculate

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

Responses

Request samples

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

Response samples

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

Orchestrators

POST Upload new customer image

Request samples

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

Response samples

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

Orchestrators

POST Upload new customer image

This endpoint is used to upload new image for customer

Request Body schema: application/json
required
required
number or string
resourceUrl
required
string

Responses

Request samples

Content type
application/json
{
  • "customerId": 0,
  • "resourceUrl": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "statusQueryGetUri": "string",
  • "sendEventPostUri": "string",
  • "terminatePostUri": "string",
  • "rewindPostUri": "string",
  • "purgeHistoryDeleteUri": "string",
  • "restartPostUri": "string",
  • "suspendPostUri": "string",
  • "resumePostUri": "string"
}
+

Request samples

Content type
application/json
{
  • "customerId": 0,
  • "resourceUrl": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "statusQueryGetUri": "string",
  • "sendEventPostUri": "string",
  • "terminatePostUri": "string",
  • "rewindPostUri": "string",
  • "purgeHistoryDeleteUri": "string",
  • "restartPostUri": "string",
  • "suspendPostUri": "string",
  • "resumePostUri": "string"
}