ex01 (0.0.1)

Download OpenAPI specification:Download

get

get-products

Request Body schema: application/json

query to filter products

searchQuery	string or null Optional search string to match product names or descriptions
minimumPrice	integer or null Optional minimum price constraint for a product
maximumPrice	integer or null Optional maximum price constraint for a product
limit	integer or null Number limit of data to be acquired.

Responses

Request samples

Payload

Content type

application/json

Example

Sample to get all products

{ }

Response samples

default

Content type

application/json

Example

Sample to get all products

[{"id": 0,
"details": {"name": "Pride and Prejudice",
"description": "A classic romance novel, describing the love story between Elizabeth Bennet and Fitzwilliam Darcy.",
"price": 800,
"count": 15
}
},
{"id": 1,
"details": {"name": "Moby Dick",
"description": "The story of captain Ahab's relentless pursuit of the white whale, Moby Dick.",
"price": 1200,
"count": 10
}
},
{"id": 2,
"details": {"name": "Dracula",
"description": "A Gothic horror novel, telling the story of the vampire Count Dracula.",
"price": 1000,
"count": 25
}
}
]

get-orders

Request Body schema: application/json

query to filter orders

products	Array of integers or null List of product IDs in the order
status	Array of strings or null (OrderStatus) Enum: "Unpaid" "Paid" "Shipped" "Delivered" "Canceled" Optional order status constraint
minimumPrice	integer or null Optional minimum total price constraint for the order
maximumPrice	integer or null Optional maximum total price constraint for the order
limit	integer or null Number limit of data to be acquired.

Responses

Request samples

Payload

Content type

application/json

Example

sample to get all orders

{ }

Response samples

default

Content type

application/json

Example

sample to get all orders

[{"id": 0,
"totalPrice": 2000,
"details": {"products": [{"_0": 0,
"_1": 1
},
{"_0": 1,
"_1": 1
}
],
"paymentMethod": {"kind": "credit-card",
"cardNumber": "1111222233334444",
"holderName": "John Smith",
"expirationDate": {"_0": 2026,
"_1": 5
},
"cvv": "123"
}
},
"status": "Delivered"
},
{"id": 1,
"totalPrice": 2000,
"details": {"products": [{"_0": 2,
"_1": 2
}
],
"paymentMethod": {"kind": "credit-card",
"cardNumber": "2222333344445555",
"holderName": "Jane Smith",
"expirationDate": {"_0": 2025,
"_1": 11
},
"cvv": "234"
}
},
"status": "Paid"
},
{"id": 2,
"totalPrice": 800,
"details": {"products": [{"_0": 0,
"_1": 1
}
],
"paymentMethod": {"kind": "credit-card",
"cardNumber": "3333444455556666",
"holderName": "Robert Johnson",
"expirationDate": {"_0": 2027,
"_1": 6
},
"cvv": "345"
}
},
"status": "Canceled"
}
]

get-product

Request Body schema: application/json

Product ID

integer (ProductId)

Responses

Request samples

Payload

Content type

application/json

Example

Succeeded with ID=0

0

0

Response samples

200
400

Content type

application/json

Example

Succeeded with ID=0

{"id": 0,
"details": {"name": "Pride and Prejudice",
"description": "A classic romance novel, describing the love story between Elizabeth Bennet and Fitzwilliam Darcy.",
"price": 800,
"count": 15
}
}

get-order

Request Body schema: application/json

Rrder ID

integer (OrderId)

Responses

Request samples

Payload

Content type

application/json

Example

Succeeded with ID=0

0

0

Response samples

200
400

Content type

application/json

Example

Succeeded with ID=0

{"id": 0,
"totalPrice": 2000,
"details": {"products": [{"_0": 0,
"_1": 1
},
{"_0": 1,
"_1": 1
}
],
"paymentMethod": {"kind": "credit-card",
"cardNumber": "1111222233334444",
"holderName": "John Smith",
"expirationDate": {"_0": 2026,
"_1": 5
},
"cvv": "123"
}
},
"status": "Delivered"
}

product

get-products

Request Body schema: application/json

query to filter products

searchQuery	string or null Optional search string to match product names or descriptions
minimumPrice	integer or null Optional minimum price constraint for a product
maximumPrice	integer or null Optional maximum price constraint for a product
limit	integer or null Number limit of data to be acquired.

Responses

Request samples

Payload

Content type

application/json

Example

Sample to get all products

{ }

Response samples

default

Content type

application/json

Example

Sample to get all products

[{"id": 0,
"details": {"name": "Pride and Prejudice",
"description": "A classic romance novel, describing the love story between Elizabeth Bennet and Fitzwilliam Darcy.",
"price": 800,
"count": 15
}
},
{"id": 1,
"details": {"name": "Moby Dick",
"description": "The story of captain Ahab's relentless pursuit of the white whale, Moby Dick.",
"price": 1200,
"count": 10
}
},
{"id": 2,
"details": {"name": "Dracula",
"description": "A Gothic horror novel, telling the story of the vampire Count Dracula.",
"price": 1000,
"count": 25
}
}
]

get-product

Request Body schema: application/json

Product ID

integer (ProductId)

Responses

Request samples

Payload

Content type

application/json

Example

Succeeded with ID=0

0

0

Response samples

200
400

Content type

application/json

Example

Succeeded with ID=0

{"id": 0,
"details": {"name": "Pride and Prejudice",
"description": "A classic romance novel, describing the love story between Elizabeth Bennet and Fitzwilliam Darcy.",
"price": 800,
"count": 15
}
}

register-product

Request Body schema: application/json

Product details to be registered to the database

name required	string Product name
description required	string Product description
price required	integer Product price
count required	integer Count of the product

Responses

Request samples

Payload

Content type

application/json

{"name": "Frankenstein",
"description": "A tale of young scientist Victor Frankenstein and his creation of a grotesque monster.",
"price": 950,
"count": 7
}

Response samples

default

Content type

application/json

3

update-product-details

Request Body schema: application/json

product details to be updated

_0 required	integer (ProductId)
required	object (ProductDetails) Product details

Responses

Request samples

Payload

Content type

application/json

Example

Updated successfully

{"_0": 0,
"_1": {"name": "Pride and Prejudice",
"description": "new desc",
"price": 800,
"count": 15
}
}

Response samples

200
400

Content type

application/json

0

0

products

get-products

Request Body schema: application/json

query to filter products

searchQuery	string or null Optional search string to match product names or descriptions
minimumPrice	integer or null Optional minimum price constraint for a product
maximumPrice	integer or null Optional maximum price constraint for a product
limit	integer or null Number limit of data to be acquired.

Responses

Request samples

Payload

Content type

application/json

Example

Sample to get all products

{ }

Response samples

default

Content type

application/json

Example

Sample to get all products

[{"id": 0,
"details": {"name": "Pride and Prejudice",
"description": "A classic romance novel, describing the love story between Elizabeth Bennet and Fitzwilliam Darcy.",
"price": 800,
"count": 15
}
},
{"id": 1,
"details": {"name": "Moby Dick",
"description": "The story of captain Ahab's relentless pursuit of the white whale, Moby Dick.",
"price": 1200,
"count": 10
}
},
{"id": 2,
"details": {"name": "Dracula",
"description": "A Gothic horror novel, telling the story of the vampire Count Dracula.",
"price": 1000,
"count": 25
}
}
]

order

get-orders

Request Body schema: application/json

query to filter orders

products	Array of integers or null List of product IDs in the order
status	Array of strings or null (OrderStatus) Enum: "Unpaid" "Paid" "Shipped" "Delivered" "Canceled" Optional order status constraint
minimumPrice	integer or null Optional minimum total price constraint for the order
maximumPrice	integer or null Optional maximum total price constraint for the order
limit	integer or null Number limit of data to be acquired.

Responses

Request samples

Payload

Content type

application/json

Example

sample to get all orders

{ }

Response samples

default

Content type

application/json

Example

sample to get all orders

[{"id": 0,
"totalPrice": 2000,
"details": {"products": [{"_0": 0,
"_1": 1
},
{"_0": 1,
"_1": 1
}
],
"paymentMethod": {"kind": "credit-card",
"cardNumber": "1111222233334444",
"holderName": "John Smith",
"expirationDate": {"_0": 2026,
"_1": 5
},
"cvv": "123"
}
},
"status": "Delivered"
},
{"id": 1,
"totalPrice": 2000,
"details": {"products": [{"_0": 2,
"_1": 2
}
],
"paymentMethod": {"kind": "credit-card",
"cardNumber": "2222333344445555",
"holderName": "Jane Smith",
"expirationDate": {"_0": 2025,
"_1": 11
},
"cvv": "234"
}
},
"status": "Paid"
},
{"id": 2,
"totalPrice": 800,
"details": {"products": [{"_0": 0,
"_1": 1
}
],
"paymentMethod": {"kind": "credit-card",
"cardNumber": "3333444455556666",
"holderName": "Robert Johnson",
"expirationDate": {"_0": 2027,
"_1": 6
},
"cvv": "345"
}
},
"status": "Canceled"
}
]

get-order

Request Body schema: application/json

Rrder ID

integer (OrderId)

Responses

Request samples

Payload

Content type

application/json

Example

Succeeded with ID=0

0

0

Response samples

200
400

Content type

application/json

Example

Succeeded with ID=0

{"id": 0,
"totalPrice": 2000,
"details": {"products": [{"_0": 0,
"_1": 1
},
{"_0": 1,
"_1": 1
}
],
"paymentMethod": {"kind": "credit-card",
"cardNumber": "1111222233334444",
"holderName": "John Smith",
"expirationDate": {"_0": 2026,
"_1": 5
},
"cvv": "123"
}
},
"status": "Delivered"
}

register-order

Request Body schema: application/json

order details to be registered to the database

required	Array of objects ID and it's count of ordered products
required	credit-card (object) or bank-transfer (object) Payment method of an order

Responses

Request samples

Payload

Content type

application/json

Example

Registered successfully

{"products": [{"_0": 0,
"_1": 1
},
{"_0": 1,
"_1": 1
}
],
"paymentMethod": {"kind": "credit-card",
"cardNumber": "3333444455556666",
"holderName": "Robert Johnson",
"expirationDate": {"_0": 2027,
"_1": 6
},
"cvv": "345"
}
}

Response samples

200
400
403

Content type

application/json

3

update-order-status

Request Body schema: application/json

order status to be updated

any (OrderStatusWithId)

Responses

Request samples

Payload

Content type

application/json

Example

Updated successfully

{"_0": 1,
"_1": "Shipped"
}

Response samples

200
400

Content type

application/json

1

orders

get-orders

Request Body schema: application/json

query to filter orders

products	Array of integers or null List of product IDs in the order
status	Array of strings or null (OrderStatus) Enum: "Unpaid" "Paid" "Shipped" "Delivered" "Canceled" Optional order status constraint
minimumPrice	integer or null Optional minimum total price constraint for the order
maximumPrice	integer or null Optional maximum total price constraint for the order
limit	integer or null Number limit of data to be acquired.

Responses

Request samples

Payload

Content type

application/json

Example

sample to get all orders

{ }

Response samples

default

Content type

application/json

Example

sample to get all orders

[{"id": 0,
"totalPrice": 2000,
"details": {"products": [{"_0": 0,
"_1": 1
},
{"_0": 1,
"_1": 1
}
],
"paymentMethod": {"kind": "credit-card",
"cardNumber": "1111222233334444",
"holderName": "John Smith",
"expirationDate": {"_0": 2026,
"_1": 5
},
"cvv": "123"
}
},
"status": "Delivered"
},
{"id": 1,
"totalPrice": 2000,
"details": {"products": [{"_0": 2,
"_1": 2
}
],
"paymentMethod": {"kind": "credit-card",
"cardNumber": "2222333344445555",
"holderName": "Jane Smith",
"expirationDate": {"_0": 2025,
"_1": 11
},
"cvv": "234"
}
},
"status": "Paid"
},
{"id": 2,
"totalPrice": 800,
"details": {"products": [{"_0": 0,
"_1": 1
}
],
"paymentMethod": {"kind": "credit-card",
"cardNumber": "3333444455556666",
"holderName": "Robert Johnson",
"expirationDate": {"_0": 2027,
"_1": 6
},
"cvv": "345"
}
},
"status": "Canceled"
}
]

register

register-product

Request Body schema: application/json

Product details to be registered to the database

name required	string Product name
description required	string Product description
price required	integer Product price
count required	integer Count of the product

Responses

Request samples

Payload

Content type

application/json

{"name": "Frankenstein",
"description": "A tale of young scientist Victor Frankenstein and his creation of a grotesque monster.",
"price": 950,
"count": 7
}

Response samples

default

Content type

application/json

3

register-order

Request Body schema: application/json

order details to be registered to the database

required	Array of objects ID and it's count of ordered products
required	credit-card (object) or bank-transfer (object) Payment method of an order

Responses

Request samples

Payload

Content type

application/json

Example

Registered successfully

{"products": [{"_0": 0,
"_1": 1
},
{"_0": 1,
"_1": 1
}
],
"paymentMethod": {"kind": "credit-card",
"cardNumber": "3333444455556666",
"holderName": "Robert Johnson",
"expirationDate": {"_0": 2027,
"_1": 6
},
"cvv": "345"
}
}

Response samples

200
400
403

Content type

application/json

3

update

update-product-details

Request Body schema: application/json

product details to be updated

_0 required	integer (ProductId)
required	object (ProductDetails) Product details

Responses

Request samples

Payload

Content type

application/json

Example

Updated successfully

{"_0": 0,
"_1": {"name": "Pride and Prejudice",
"description": "new desc",
"price": 800,
"count": 15
}
}

Response samples

200
400

Content type

application/json

0

0

update-order-status

Request Body schema: application/json

order status to be updated

any (OrderStatusWithId)

Responses

Request samples

Payload

Content type

application/json

Example

Updated successfully

{"_0": 1,
"_1": "Shipped"
}

Response samples

200
400

Content type

application/json

1