Carousel
Upsert Carousel
Create or update carousels for a specific market and branch.
Authorization
default AuthorizationBearer <token>
You can retrieve your token by logging in.
In: header
Header Parameters
X-API-Version*string
API contract version to target. See the Changelog for what changed in each version.
Default
"2.0.0"Value in
"2.3.0" | "2.2.0" | "2.1.0" | "2.0.0"Request Body
application/json
market_id*string
Market ID. The id of an existing record in the markets table.
branch_id*string
Branch ID. The id of an existing record in the branches table.
images*array<>
Array of carousel images. Must have at least 1 items.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:8000/api/v2/carousels" \ -H "X-API-Version: 2.3.0" \ -H "Content-Type: application/json" \ -d '{ "market_id": "uuid", "branch_id": "uuid", "images": [ { "id": "uuid", "title": "Summer Sale", "image_url": "https://example.com/image1.jpg" } ] }'{
"meta": {
"code": 200,
"status": "success",
"message": "Carousel upsert successfully."
},
"data": null
}{
"meta": {
"code": 401,
"status": "error",
"message": "Unauthenticated."
},
"data": null
}{
"meta": {
"code": 403,
"status": "error",
"message": "Unauthorized."
},
"data": null
}{
"meta": {
"code": 404,
"status": "error",
"message": "Resource not found."
},
"data": null
}{
"meta": {
"code": 422,
"status": "error",
"message": "The selected market id is invalid. (and 2 more errors)"
},
"data": [
{
"code": 0,
"message": "The selected market is invalid.",
"field": "market"
},
{
"code": 0,
"message": "The selected branch is invalid.",
"field": "branch"
},
{
"code": 0,
"message": "The images.0.image_url must be a valid URL.",
"field": "images.0.image_url"
}
]
}{
"meta": {
"code": 500,
"status": "error",
"message": "Internal server error."
},
"data": null
}