The API calls are made in this sequence when making a purchase:
Get CatalogCustomer VisitsNew CartAdd Item to Cart(Can be called multiple times)Checkout CartSearch Orders
Retrieves the catalog of items. Each unique item combination should have only a single price. You can have at most 6 potion SKUs offered in your catalog at one time.
Response:
[
{
"sku": "string", /* Matching regex ^[a-zA-Z0-9_]{1,20}$ */
"name": "string",
"quantity": "integer", /* Between 1 and 10000 */
"price": "integer", /* Between 1 and 500 */
"potion_type": [r, g, b, d] /* r, g, b, d are integers that add up to exactly 100 */
}
]Shares the customers that visited the store on that tick. Not all customers end up purchasing because they may not like what they see in the current catalog.
Request:
[
{
"customer_name": "string",
"character_class": "string",
"level": "number"
},
{
...
}
]Response:
{
"success": "boolean"
}Creates a new cart for a specific customer.
Request:
{
"customer_name": "string",
"character_class": "string",
"level": "number"
}Response:
{
"cart_id": "string" /* This id will be used for future calls to add items and checkout */
}Updates the quantity of a specific item in a cart.
Request:
{
"quantity": "integer"
}Response:
{
"success": "boolean"
}Handles the checkout process for a specific cart.
Request:
{
"payment": "string",
}Response:
{
"total_potions_bought": "integer",
"total_gold_paid": "integer"
}Searches for orders based on specified query parameters.
Query Parameters:
customer_name(optional): The name of the customer.potion_sku(optional): The SKU of the potion.search_page(optional): The page number of the search results.sort_col(optional): The column to sort the results by. Possible values:customer_name,item_sku,line_item_total,timestamp. Default:timestamp.sort_order(optional): The sort order of the results. Possible values:asc(ascending),desc(descending). Default:desc.
Response:
The API returns a JSON object with the following structure:
previous: A string that represents the link to the previous page of results. If there is no previous page, this value is an empty string.next: A string that represents the link to the next page of results. If there is no next page, this value is an empty string.results: An array of objects, each representing a line item. Each line item object has the following properties:line_item_id: An integer that represents the unique identifier of the line item.item_sku: A string that represents the SKU of the item. This includes the quantity and the name of the item.customer_name: A string that represents the name of the customer who purchased the item.line_item_total: An integer that represents the total cost of the line item.timestamp: A string that represents the date and time when the line item was created. This is in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).
The API calls are made in this sequence when the bottler comes:
Get Bottle PlanDeliver Bottles
Gets the plan for bottling potions.
Response:
[
{
"potion_type": [r, g, b, d],
"quantity": "integer"
}
]Posts delivery of potions. order_id is a unique value representing a single delivery.
Request:
[
{
"potion_type": [r, g, b, d],
"quantity": "integer"
}
]The API calls are made in this sequence when Barrel Purchases can be made:
Get Barrel Purchase PlanDeliver Barrels
Gets the plan for purchasing wholesale barrels. The call passes in a catalog of available barrels and the shop returns back which barrels they'd like to purchase and how many.
Request:
[
{
"sku": "string",
"ml_per_barrel": "integer",
"potion_type": "integer",
"price": "integer",
"quantity": "integer"
}
]Response:
[
{
"sku": "string", /* Must match a sku from the catalog just passed in this call */
"quantity": "integer" /* A number between 1 and the quantity available for sale */
}
]Posts delivery of barrels. order_id is a unique value representing a single delivery.
Request:
[
{
"sku": "string",
"ml_per_barrel": "integer",
"potion_type": "integer",
"price": "integer",
"quantity": "integer"
}
]A call to reset shop will delete all inventory and in-flight carts and reset gold back to 100. The shop should take this as an opportunity to remove all of their inventory and set their gold back to 100 as well.
Shares what the latest time (in game time) is.
Request:
[
{
"day": "string",
"hour": "number"
}
]Return a summary of your current number of potions, ml, and gold.
Response:
{
"number_of_potions": "number",
"ml_in_barrels": "number",
"gold": "number"
)What additional potion or ML capacity the shop would like to buy. Called once a day. You start with 1 capacity of potion and 1 capacity of ml storage. Each potion capacity allows 50 potion storage. Each ml capacity allows 10k of ml storage.
Response:
{
"potion_capacity": "number",
"ml_capacity": "number"
}Delivers capacity purchased back to shop. Called when a capacity purchase succeeds.
Request:
{
"potion_capacity": "number",
"ml_capacity": "number"
}