diff --git a/docs/index.html b/docs/index.html index a67d1735..3abf4f6a 100644 --- a/docs/index.html +++ b/docs/index.html @@ -531,7 +531,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

@@ -543,7 +543,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

@@ -561,7 +561,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

@@ -587,7 +587,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

@@ -601,7 +601,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

GET Get customer upload resource url

Request samples

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

Response samples

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

Customer

GET Get customer upload resource url

This endpoint gets customer upload resource url, so customer can upload image

path Parameters
customerId
required
string

Responses

Response samples

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

GET Get order with lineItems array

Response samples

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

GET Get order with lineItems array

This endpoint gets order with lineItems array of objects

path Parameters
customerId
required
string

customerId for the customer

@@ -815,7 +815,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

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

Forbidden

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

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

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

Request samples

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

Response samples

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

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

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

GET Get shipping

Request samples

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

Response samples

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

GET Get shipping

This endpoint gets shipping object

path Parameters
shippingId
required
string

Responses

Response samples

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

Orchestrators

POST Upload new customer image

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