diff --git a/docs/index.html b/docs/index.html index 0dd89f1d..f3d0935a 100644 --- a/docs/index.html +++ b/docs/index.html @@ -797,7 +797,7 @@ " class="sc-eeDSqt sc-eBMFzZ bSgSrX cWARBq sc-dCFGXG gKOXES">
Not found
{- "success": true,
- "payload": {
- "title": "string",
- "options": [
- {
- "productId": 0,
- "title": "string",
- "variants": [
- {
- "variantId": 0,
- "title": "string",
- "price": "string",
- "duration": {
- "value": 0,
- "metafieldId": 0
}
}
]
}
], - "description": "string",
- "descriptionHtml": "string",
- "productHandle": "string",
- "productId": 0,
- "variantId": 0,
- "hideFromProfile": true,
- "hideFromCombine": true,
- "price": {
- "amount": "string",
- "currencyCode": "string"
}, - "compareAtPrice": {
- "amount": "string",
- "currencyCode": "string"
}, - "duration": 0,
- "breakTime": 0,
- "noticePeriod": {
- "value": 0,
- "unit": "hours"
}, - "bookingPeriod": {
- "value": 0,
- "unit": "weeks"
}, - "locations": [
- {
- "location": "string",
- "locationType": "home"
}
], - "scheduleId": "string",
- "scheduleName": "string"
}
}
This endpoint update product that exist in schedule
-customerId required | string |
productId required | string |
hideFromProfile | string |
hideFromCombine | string |
object | |
object | |
duration | number |
breakTime | number |
object (CustomerProductNoticePeriod) | |
object (CustomerProductBookingPeriod) | |
Array of objects (CustomerProductLocations) | |
title | string |
description | string |
descriptionHtml | string |
{- "hideFromProfile": "string",
- "hideFromCombine": "string",
- "price":
{- "amount": "string",
- "currencyCode": "string"
}, - "compareAtPrice":
{- "amount": "string",
- "currencyCode": "string"
}, - "duration": 0,
- "breakTime": 0,
- "noticePeriod":
{- "value": 0,
- "unit": "hours"
}, - "bookingPeriod":
{- "value": 0,
- "unit": "weeks"
}, - "locations":
[ {- "location": "string",
- "locationType": "home"
}
], - "title": "string",
- "description": "string",
- "descriptionHtml": "string"
}
{- "success": true,
- "payload":
{- "title": "string",
- "options":
[ {- "productId": 0,
- "title": "string",
- "variants":
[ {- "variantId": 0,
- "title": "string",
- "price": "string",
- "duration":
{- "value": 0,
- "metafieldId": 0
}
}
]
}
], - "description": "string",
- "descriptionHtml": "string",
- "productHandle": "string",
- "productId": 0,
- "variantId": 0,
- "hideFromProfile": true,
- "hideFromCombine": true,
- "price":
{- "amount": "string",
- "currencyCode": "string"
}, - "compareAtPrice":
{- "amount": "string",
- "currencyCode": "string"
}, - "duration": 0,
- "breakTime": 0,
- "noticePeriod":
{- "value": 0,
- "unit": "hours"
}, - "bookingPeriod":
{- "value": 0,
- "unit": "weeks"
}, - "locations":
[ {- "location": "string",
- "locationType": "home"
}
], - "scheduleId": "string",
- "scheduleName": "string"
}
}
{- "hideFromProfile": "string",
- "hideFromCombine": "string",
- "productType": "string",
- "price":
{- "amount": "string",
- "currencyCode": "string"
}, - "compareAtPrice":
{- "amount": "string",
- "currencyCode": "string"
}, - "duration": 0,
- "breakTime": 0,
- "noticePeriod":
{- "value": 0,
- "unit": "hours"
}, - "bookingPeriod":
{- "value": 0,
- "unit": "weeks"
}, - "locations":
[ {- "location": "string",
- "locationType": "home"
}
], - "title": "string",
- "description": "string",
- "descriptionHtml": "string"
}
{- "success": true,
- "payload":
{- "title": "string",
- "options":
[ {- "productId": 0,
- "title": "string",
- "variants":
[ {- "variantId": 0,
- "title": "string",
- "price": "string",
- "duration":
{- "value": 0,
- "metafieldId": 0
}
}
]
}
], - "description": "string",
- "descriptionHtml": "string",
- "productHandle": "string",
- "productId": 0,
- "variantId": 0,
- "hideFromProfile": true,
- "hideFromCombine": true,
- "price":
{- "amount": "string",
- "currencyCode": "string"
}, - "compareAtPrice":
{- "amount": "string",
- "currencyCode": "string"
}, - "duration": 0,
- "breakTime": 0,
- "noticePeriod":
{- "value": 0,
- "unit": "hours"
}, - "bookingPeriod":
{- "value": 0,
- "unit": "weeks"
}, - "locations":
[ {- "location": "string",
- "locationType": "home"
}
], - "scheduleId": "string",
- "scheduleName": "string"
}
}
This endpoint remove product from schedule for customer
customerId required | string |
productId required | string |
Response
@@ -821,7 +821,7 @@ " class="sc-eeDSqt sc-eBMFzZ bSgSrX cWARBq sc-dCFGXG gKOXES">Not found
{- "success": true,
- "payload":
{- "matchedCount": 0,
- "modifiedCount": 0,
- "upsertedCount": 0
}
}
This endpoint add product that does not exist in schedule
-customerId required | string |
title required | string |
description required | string |
descriptionHtml required | string |
required | Array of objects (CustomerProductLocations) |
scheduleId required | string |
hideFromProfile required | string |
hideFromCombine required | string |
required | object |
required | object |
customerId required | string |
title required | string |
productType required | string |
description required | string |
descriptionHtml required | string |
required | Array of objects (CustomerProductLocations) |
scheduleId required | string |
hideFromProfile required | string |
hideFromCombine required | string |
required | object |
required | object |
Response with schedule product payload
Bad Request
@@ -831,7 +831,7 @@ " class="sc-eeDSqt sc-eBMFzZ bSgSrX cWARBq sc-dCFGXG gKOXES">Forbidden
Not found
- {- "title": "string",
- "description": "string",
- "descriptionHtml": "string",
- "locations":
[ {- "location": "string",
- "locationType": "home"
}
], - "scheduleId": "string",
- "hideFromProfile": "string",
- "hideFromCombine": "string",
- "price":
{- "amount": "string",
- "currencyCode": "string"
}, - "compareAtPrice":
{- "amount": "string",
- "currencyCode": "string"
}
}
{- "success": true,
- "payload":
{- "title": "string",
- "options":
[ {- "productId": 0,
- "title": "string",
- "variants":
[ {- "variantId": 0,
- "title": "string",
- "price": "string",
- "duration":
{- "value": 0,
- "metafieldId": 0
}
}
]
}
], - "description": "string",
- "descriptionHtml": "string",
- "productHandle": "string",
- "productId": 0,
- "variantId": 0,
- "hideFromProfile": true,
- "hideFromCombine": true,
- "price":
{- "amount": "string",
- "currencyCode": "string"
}, - "compareAtPrice":
{- "amount": "string",
- "currencyCode": "string"
}, - "duration": 0,
- "breakTime": 0,
- "noticePeriod":
{- "value": 0,
- "unit": "hours"
}, - "bookingPeriod":
{- "value": 0,
- "unit": "weeks"
}, - "locations":
[ {- "location": "string",
- "locationType": "home"
}
], - "scheduleId": "string",
- "scheduleName": "string"
}
}
{- "title": "string",
- "productType": "string",
- "description": "string",
- "descriptionHtml": "string",
- "locations":
[ {- "location": "string",
- "locationType": "home"
}
], - "scheduleId": "string",
- "hideFromProfile": "string",
- "hideFromCombine": "string",
- "price":
{- "amount": "string",
- "currencyCode": "string"
}, - "compareAtPrice":
{- "amount": "string",
- "currencyCode": "string"
}
}
{- "success": true,
- "payload":
{- "title": "string",
- "options":
[ {- "productId": 0,
- "title": "string",
- "variants":
[ {- "variantId": 0,
- "title": "string",
- "price": "string",
- "duration":
{- "value": 0,
- "metafieldId": 0
}
}
]
}
], - "description": "string",
- "descriptionHtml": "string",
- "productHandle": "string",
- "productId": 0,
- "variantId": 0,
- "hideFromProfile": true,
- "hideFromCombine": true,
- "price":
{- "amount": "string",
- "currencyCode": "string"
}, - "compareAtPrice":
{- "amount": "string",
- "currencyCode": "string"
}, - "duration": 0,
- "breakTime": 0,
- "noticePeriod":
{- "value": 0,
- "unit": "hours"
}, - "bookingPeriod":
{- "value": 0,
- "unit": "weeks"
}, - "locations":
[ {- "location": "string",
- "locationType": "home"
}
], - "scheduleId": "string",
- "scheduleName": "string"
}
}
This endpoint add product option to product
customerId required | string |
productId required | string |
cloneId required | string |
title required | string |
Response with product option payload
@@ -1323,9 +1323,9 @@ " class="sc-eeDSqt sc-eBMFzZ bSgSrX cWARBq sc-dCFGXG gKOXES">Unauthorized
Forbidden
- {- "title": "string",
- "description": "string"
}
{- "success": true,
- "payload":
{- "title": "string",
- "description": "string"
}
}
{- "title": "string",
- "description": "string"
}
{- "success": true,
- "payload":
{- "collection":
{- "id": "string",
- "title": "string"
}, - "title": "string",
- "description": "string"
}
}