The TopsPizza.co.uk API (1.0.0)

Download OpenAPI specification:Download

The TopsPizza.co.uk API

Auth

Login

Do user login

Request Body schema: application/json

email required	string User's email
password required	string password
platform required	string Platform the user would recognize

Responses

Request samples

Payload

Content type

application/json

{"email": "string",
"password": "string",
"platform": "string"
}

Response samples

200
400
404
422

Content type

application/json

{"status": "string",
"message": "string",
"data": {"token": "string",
"user": { }
}
}

Login Facebook

Do customer login with facebook

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200
400
404
422

Content type

application/json

"string"

Login Facebook callback

Facebook login callback

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200
400
404
422

Content type

application/json

{ }

Login Apple

Do customer login with apple

Request Body schema: application/json

email

string

Responses

Request samples

Payload

Content type

application/json

{"email": "string"
}

Response samples

200
400
404
422

Content type

application/json

"string"

Logout

Do customer logout

Responses

Response samples

400
401
404

Content type

application/json

{"status": "string",
"message": "string",
"data": "string"
}

Register

Do customer register

Request Body schema: application/json

name required	string Customer's name
email required	string Customer's email
password required	string password
password_confirmation required	string confirm password

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"email": "string",
"password": "string",
"password_confirmation": "string"
}

Response samples

200
400
404
422

Content type

application/json

"string"

Forgot password

Will send reset password link in email

Request Body schema: application/json

email

string

Customer's email

Responses

Request samples

Payload

Content type

application/json

{"email": "string"
}

Response samples

200
400
404
422

Content type

application/json

{ }

Reset password

Do customer reset password

Request Body schema: application/json

token	string Token given in reset-password link through email
email	string Customer's email
password	string Customer's new password
password_confirmation	string Customer's new password confirmation

Responses

Request samples

Payload

Content type

application/json

{"token": "string",
"email": "string",
"password": "string",
"password_confirmation": "string"
}

Response samples

200
400
404
422

Content type

application/json

{ }

Settings

Get app min version

Get App Min Version

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200
400
401
404

Content type

application/json

{"status": "string",
"message": "string",
"data": {"app_version_android": 0,
"app_version_ios": 0
}
}

Get server time

Get Server Time

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200
400
401
404

Content type

application/json

{"status": "string",
"message": "string",
"data": {"appTimezone": "string",
"currentTime": 0
}
}

Customers

Get customer

Get Customer by id

header Parameters

Authorization

required

string <Bearer>

Api token placed into the header to allow access to the api service Authorization Bearer auth_token

Request Body schema: application/json

id	string The encrypted customer id

Responses

Request samples

Payload

Content type

application/json

{"id": "string"
}

Response samples

200
400
401
404

Content type

application/json

{"status": "string",
"message": "string",
"data": {"id": "string",
"decodeId": "string",
"hashedId": "string",
"customer_id": "string",
"first_name": "string",
"last_name": "string",
"name": "string",
"email": "string",
"rate": 0,
"note": "string",
"phone_number": 0,
"phone_number_mobile": "string",
"newsletter_subscribed": 0,
"loyalty_points": 0,
"rolesWithStore": [ ],
"roles": "string"
}
}

Update customer

Update Customer Data

header Parameters

Authorization

required

string <Bearer>

Api token placed into the header to allow access to the api service Authorization Bearer auth_token

Request Body schema: application/json

id required	string The encrypted customer id
first_name	string The first name
last_name	string The last name
email	string The email
rate	number The customer ratings
note	string The note
phone_number	number The phone number
phone_number_mobile	string The mobile phone number
newsletter_subscribed	string Enum: 0 1 The newsletter subscription, 0 means unsubscribed and 1 means subscribed

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"first_name": "string",
"last_name": "string",
"email": "string",
"rate": 0,
"note": "string",
"phone_number": 0,
"phone_number_mobile": "string",
"newsletter_subscribed": 0
}

Response samples

200
400
401
404

Content type

application/json

{"status": "string",
"message": "string",
"data": {"id": "string",
"decodeId": "string",
"hashedId": "string",
"customer_id": "string",
"first_name": "string",
"last_name": "string",
"name": "string",
"email": "string",
"note": "string",
"phone_number": 0,
"phone_number_mobile": "string",
"newsletter_subscribed": 0,
"loyalty_points": 0,
"rolesWithStore": [ ],
"roles": "string"
}
}

Delete customer

Delete Customer Account

header Parameters

Authorization

required

string <Bearer>

Api token placed into the header to allow access to the api service Authorization Bearer auth_token

Request Body schema: application/json

id required	string The user id
expires required	number The link expiry timestamp
signature required	string The signature code for link validation

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"expires": 0,
"signature": "string"
}

Response samples

200
400
401
404

Content type

application/json

{"status": "string",
"message": "string",
"data": "string"
}

Create customer

Create Customer Data

header Parameters

Authorization

required

string <Bearer>

Api token placed into the header to allow access to the api service Authorization Bearer auth_token

Request Body schema: application/json

first_name required	string The first name
phone_number_mobile required	string The mobile phone number

Responses

Request samples

Payload

Content type

application/json

{"first_name": "string",
"phone_number_mobile": "string"
}

Response samples

200
400
401
404

Content type

application/json

{"status": "string",
"message": "string",
"data": {"user": {"id": "string",
"decodeId": "string",
"hashedId": "string",
"customer_id": "string",
"first_name": "string",
"last_name": "string",
"email": "string",
"rate": "string",
"note": "string",
"phone_number": 0,
"phone_number_mobile": "string",
"newsletter_subscribed": 0,
"loyalty_points": 0,
"rolesWithStore": [ ],
"roles": "string"
},
"addresses": [{"id": "string",
"customer": "string",
"customer_id": "string",
"postcode": "string",
"postcode_id": "string",
"postcode_lat": "string",
"postcode_lon": "string",
"name": "string",
"note": "string",
"is_default": "string",
"street": 0,
"number": "string",
"city": "string",
"store": {"name": "string",
"id": 0
},
"deleted_at": "string",
"charge": "string",
"extra_charge": "string",
"minimum_order": "string"
}
]
}
}

Get loyalty

Get Customer Loyalty points

header Parameters

Authorization

required

string <Bearer>

Api token placed into the header to allow access to the api service Authorization Bearer auth_token

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200
400
401
404

Content type

application/json

{"status": "string",
"message": "string",
"data": {"loyalty_points": 0
}
}

Find customer

Find Customer data

header Parameters

Authorization

required

string <Bearer>

Api token placed into the header to allow access to the api service Authorization Bearer auth_token

Request Body schema: application/json

phone_number required	number The customer mobile phone number
customer_id required	string The encrypted customer id

Responses

Request samples

Payload

Content type

application/json

{"phone_number": 0,
"customer_id": "string"
}

Response samples

200
400
401
404

Content type

application/json

{"status": "string",
"message": "string",
"data": {"user": {"id": "string",
"decodeId": "string",
"hashedId": "string",
"customer_id": "string",
"first_name": "string",
"last_name": "string",
"email": "string",
"rate": "string",
"note": "string",
"phone_number": 0,
"phone_number_mobile": "string",
"newsletter_subscribed": 0,
"loyalty_points": 0,
"rolesWithStore": [ ],
"roles": "string"
},
"addresses": [{"id": "string",
"customer": "string",
"customer_id": "string",
"postcode": "string",
"postcode_id": "string",
"postcode_lat": "string",
"postcode_lon": "string",
"name": "string",
"note": "string",
"is_default": "string",
"street": 0,
"number": "string",
"city": "string",
"store": {"name": "string",
"id": 0
},
"deleted_at": "string",
"charge": "string",
"extra_charge": "string",
"minimum_order": "string"
}
]
}
}

Get Addresses

Get Customer Addresses / Get Postcode Addresses

header Parameters

Authorization

required

string <Bearer>

Api token placed into the header to allow access to the api service Authorization Bearer auth_token

Request Body schema: application/json

postcode

string

The postcode

Responses

Request samples

Payload

Content type

application/json

{"postcode": "string"
}

Response samples

200
400
401
404

Content type

application/json

{"status": "string",
"message": "string",
"data": [{"id": "string",
"customer": "string",
"customer_id": "string",
"postcode": "string",
"postcode_id": "string",
"note": "string",
"is_default": 0,
"street": "string",
"number": 0,
"city": "string",
"store": {"name": "string",
"id": 0,
"charge": 0
}
}
]
}

Update address

Update customer address or create if not exists

header Parameters

Authorization

required

string <Bearer>

Api token placed into the header to allow access to the api service Authorization Bearer auth_token

Request Body schema: application/json

id	number The user address id
postcode required	string The postcode
postcode_id	string The postcode id
customer_id required	string The customer id
note	string The address note
is_default	string The default
street required	number The street
number	number The number
city	string The city

Responses

Request samples

Payload

Content type

application/json

{"id": 0,
"postcode": "string",
"postcode_id": "string",
"customer_id": "string",
"note": "string",
"is_default": "string",
"street": 0,
"number": 0,
"city": "string"
}

Response samples

200
400
401
404

Content type

application/json

{"status": "string",
"message": "string",
"data": {"id": "string",
"customer": "string",
"customer_id": "string",
"postcode": "string",
"postcode_id": "string",
"postcode_lat": "string",
"postcode_lon": "string",
"name": "string",
"note": "string",
"is_default": "string",
"street": 0,
"number": "string",
"city": "string",
"store": {"name": "string",
"id": 0
},
"deleted_at": "string",
"charge": "string",
"extra_charge": "string",
"minimum_order": "string"
}
}

Update rate

Rate Customer

header Parameters

Authorization

required

string <Bearer>

Api token placed into the header to allow access to the api service Authorization Bearer auth_token

Request Body schema: application/json

id required	string The encrypted customer id
rate required	number Enum: 0 1 2 3 4 5 The customer ratings

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"rate": 0
}

Response samples

200
400
401
404

Content type

application/json

{"status": "string",
"message": "string",
"data": [{"id": "string",
"first_name": "string",
"last_name": "string",
"email": "string",
"rate": 0,
"note": "string",
"phone_number": 0,
"phone_number_mobile": "string"
}
]
}

Rate customer

Add ratings to customer

Request Body schema: application/json

customer_id required	string The encrypted customer id
rate	number Enum: 0 1 2 The rating for customer. 0 means blocked, 1 means bad and 2 means good.
note	string The note/feedback on the customer

Responses

Request samples

Payload

Content type

application/json

{"customer_id": "string",
"rate": 0,
"note": "string"
}

Response samples

200
400
404
422

Content type

application/json

{"status": "string",
"message": "string",
"data": {"id": "string",
"decoded_Id": "string",
"hashedId": "string",
"customer_id": 0,
"first_name": "string",
"last_name": "string",
"name": "string",
"email": "string",
"rate": 0,
"note": "string",
"phone_number": 0,
"phone_number_mobile": "string",
"newsletter_subscribed": 0,
"loyalty_points": 0,
"rolesWithStore": [ ],
"roles": "string"
}
}

Request delete

Request account delete

header Parameters

Authorization

required

string <Bearer>

Api token placed into the header to allow access to the api service Authorization Bearer auth_token

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200
400
401
404

Content type

application/json

{"status": "string",
"message": "string",
"data": "string"
}

Stores

Get stores

Get list of Stores

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200
400
401
404

Content type

application/json

{"status": "string",
"message": "string",
"data": [{"id": 0,
"name": "string",
"nickname": "string",
"active": 0,
"city": "string",
"address": "string",
"postcode": {"id": 0,
"postcode": "string",
"city": "string",
"lat": "string",
"lon": "string",
"area": "string",
"district": "string",
"sector": "string"
},
"phone_number": 0,
"emergency_phone_number": 0,
"emergency_phone_number_1": 0,
"minumum_order": 0,
"delivery_charge": 0,
"max_distance": 0,
"store_schedule": "string"
}
]
}

Search store

Get Store

Request Body schema: application/json

store_id	integer The Store Id
postcode	string The store postcode

Responses

Request samples

Payload

Content type

application/json

{"store_id": 0,
"postcode": "string"
}

Response samples

200
400
401
404

Content type

application/json

{"status": "string",
"message": "string",
"data": {"store": {"id": 0,
"name": "string",
"nickname": "string",
"city": "string",
"address": "string",
"postcode": "string",
"phone_number": "string",
"pizza_sizes": [ ],
"emergency_message": "string"
},
"storeInfo": {"h1_title": "string",
"desc_left": "string",
"desc_right": "string",
"schedule": {"monday": "string",
"tuesday": "string",
"wednesday": "string",
"thursday": "string",
"friday": "string",
"saturday": "string",
"sunday": "string"
},
"lon": "string",
"lat": "string",
"telephone": "string",
"delivery": 0
},
"products": "string",
"banners": [{"id": 0,
"description": "string",
"positions": [ ],
"slides": [{"days": [ ],
"link": "string",
"image": "string"
}
]
}
],
"ingredientGroups": [{"name": "string",
"ingredients": [{"name": "string",
"id": 0
}
]
}
],
"freePizzaRewardDeal": { },
"settings": {"serviceCharge": 0,
"totalMaxLimit": null
}
}
}

Orders

Get orders

Get customer orders or store orders

header Parameters

Authorization

required

string <Bearer>

Api token placed into the header to allow access to the api service Authorization Bearer auth_token

Request Body schema: application/json

id	string The encrypted store id
customer_id	string The encrypted customer id
type required	string Enum: "customer" "store"
per_page required	number Number of orders per page
page required	number The page number
startDate	date The start date
endDate	date The end date
status	string Enum: "payment_pending" "paid" "payment_failed" "pending" "accepted" "cooking" "cooked" "to_be_delivered" "picked_up_for_delivery" "left_the_shop" "delivered" "out_of_coverage" "double_order" "shop_closing" "bad_weather" "refunded" "refund" "canceled" The status

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"customer_id": "string",
"type": "customer",
"per_page": 0,
"page": 0,
"startDate": null,
"endDate": null,
"status": "payment_pending"
}

Response samples

200
400
401
404

Content type

application/json

{"status": "string",
"message": "string",
"data": {"data": [{"id": "string",
"store": {"id": 0,
"name": "string"
},
"customer": "string",
"customer_phone": "string",
"customer_phone_number": "string",
"customer_id": "string",
"delivered_by": "string",
"driver_name": "string",
"driver_cash_off": "string",
"status": "string",
"source": "string",
"payment_type": "string",
"estimated_at": "string",
"requested_at": "string",
"delivered_at": "string",
"total": 0,
"delivery_charge": 0,
"service_charge": 0,
"type": "collection",
"created_at": "string",
"address": {"id": "string",
"customer": "string",
"customer_id": "string",
"postcode": "string",
"postcode_id": "string",
"postcode_lat": "string",
"postcode_lon": "string",
"name": "string",
"note": "string",
"is_default": 0,
"street": "string",
"number": 0,
"city": "string",
"store": {"name": "string",
"id": 0
},
"deleted_at": "string",
"charge": 0,
"extra_charge": "string",
"minimum_order": 0
},
"order_data": "string",
"delivery_data": "string",
"customer_note": {"id": 0,
"rate": "string",
"note": 0
},
"comment": "string",
"notes_for_delivery": "string",
"notes_for_staff": "string",
"notes_for_chef": "string",
"notes_for_order": "string",
"grandTotal": "string",
"platform": {"name": "string",
"platform": "string"
},
"voucher": {"id": "string",
"code": "string",
"description": "string",
"type": "deal",
"settings": { },
"auto_apply": 0,
"left_amount": "string",
"used_amount_order": "string"
}
}
],
"links": {"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"meta": {"current_page": "string",
"from": "string",
"last_page": "string",
"links": {"url": "string",
"label": "string",
"active": "string"
},
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}
}

Create orders

Create customer order

header Parameters

Authorization

required

string <Bearer>

Api token placed into the header to allow access to the api service Authorization Bearer auth_token

Request Body schema: application/json

platform required	string Enum: "web" "app" "pos" The platform
id	string The encrypted customer id
cart required	Array of arrays The cart items
requested_at required	number The requested at time
order_type required	string Enum: "delivery" "collection" "shop" The order type
address	number The delivery address id
store_id required	number The store Id
payment_method required	string Enum: "cash" "card" The payment type
voucher_id	number The voucher id
user_id	string The encrypted user id
directDiscountAmount	number The direct discount value given by pos user
directDiscountReason	string The reason for the direct discount
comment	number The comment from customer
notesForDelivery	string The notes for delivery
notesForStaff	number The notes for staff
notesForChef	string The notes for chef
notesForOrder	string The notes for order

Responses

Request samples

Payload

Content type

application/json

{"platform": "web",
"id": "string",
"cart": [ ],
"requested_at": 0,
"order_type": "delivery",
"address": 0,
"store_id": 0,
"payment_method": "cash",
"voucher_id": 0,
"user_id": "string",
"directDiscountAmount": 0,
"directDiscountReason": "string",
"comment": 0,
"notesForDelivery": "string",
"notesForStaff": 0,
"notesForChef": "string",
"notesForOrder": "string"
}

Response samples

200
400
401
404

Content type

application/json

{"status": "string",
"message": "string",
"data": {"id": 0,
"store": {"id": 0,
"name": "string"
},
"customer_loyalty_points": 0,
"requested_at": "string",
"type": "string",
"address": { }
}
}

Update order

Update order Data

path Parameters

id

required

integer

The order id

header Parameters

Authorization

required

string <Bearer>

Api token placed into the header to allow access to the api service Authorization Bearer auth_token

Request Body schema: application/json

status	string Enum: "payment_pending" "paid" "payment_failed" "pending" "accepted" "cooking" "to_be_delivered" "picked_up_for_delivery" "left_the_shop" "delivered" "out_of_coverage" "double_order" "shop_closing" "bad_weather" "refunded" "refund" "canceled" The order statuses
reason	string Cancelled by store reason
store_id	string The id of the store
estimated_at	string The estimated time
delivered_at	string The delivered time
	object Data from driver's app

Responses

Request samples

Payload

Content type

application/json

{"status": "payment_pending",
"reason": "string",
"store_id": "string",
"estimated_at": "string",
"delivered_at": "string",
"delivery_data": {"note": "string",
"rate": "string",
"photo": "string"
}
}

Response samples

204
401
404

Content type

application/json

{"status": "string",
"message": "string"
}

Rate order

Add ratings to order

Request Body schema: application/json

order_id required	number The order id
rating required	number Enum: 0 1 2 3 4 5 The order ratings
note	string The feedback note

Responses

Request samples

Payload

Content type

application/json

{"order_id": 0,
"rating": 0,
"note": "string"
}

Response samples

200
400
404
422

Content type

application/json

{"status": "string",
"message": "string",
"data": {"id": 0,
"customer_id": 0,
"order_id": 0,
"note": "string",
"rate": 0
}
}

Get receipt

Get order receipt

path Parameters

id

required

integer

The order id

query Parameters

format

string

Default: "json"

Enum: "json" "pdf" "base64" "html"

You can receive a receipt in different formats

header Parameters

Authorization

required

string <Bearer>

Api token placed into the header to allow access to the api service Authorization Bearer auth_token

Responses

Response samples

200
404

Content type

application/json

{"status": "string",
"message": "string",
"data": [{"id": 0,
"payment_type": "string",
"type": "string",
"status": "string",
"total": "string",
"delivery_charge": "string",
"service_charge": "string",
"created_at": "string",
"customer": {"name": "string",
"street": "string",
"number": "string",
"city": "string",
"postcode": "string"
},
"store": {"name": "string",
"address": "string",
"city": "string",
"postcode": "string",
"phone_number": "string"
},
"order_items": [{"id": 0,
"order_id": 0,
"name": "string",
"parent_id": 0,
"price": "string",
"size": "string",
"product_type": "string",
"qty": 0
}
],
"payment": {"card_type": "string",
"last_4_digits": 0
}
}
]
}

Banners

Get banners

Get Banners

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200
400
401
404

Content type

application/json

{"status": "string",
"message": "string",
"data": [{"id": 0,
"description": "string",
"is_active": 0,
"postions": [ ],
"slides": [{"key": "string",
"layout": "string",
"attributes": {"days": [ ],
"link": "string",
"image": "string"
}
}
]
}
]
}

Info pages

Get info pages

Get Info Pages

Request Body schema: application/json

platform required	string Enum: "web" "app" Frontend platform
store_id	integer The store id

Responses

Request samples

Payload

Content type

application/json

{"platform": "web",
"store_id": 0
}

Response samples

200
400
401
404

Content type

application/json

{"status": "string",
"message": "string",
"data": [{"id": 0,
"title": "string",
"content": "string",
"tags": [ ]
}
]
}

Vouchers

Get voucher

Get voucher by code

Request Body schema: application/json

platform required	string Enum: "web" "app" Frontend platform
store_id required	integer The store id
auto_apply required	integer Enum: 0 1 1 means auto-apply while 0 means not
code required	string Voucher code
cart_total	float The cart total

Responses

Request samples

Payload

Content type

application/json

{"platform": "web",
"store_id": 0,
"auto_apply": 0,
"code": "string",
"cart_total": null
}

Response samples

200
400
404
422

Content type

application/json

{"status": "string",
"message": "string",
"data": {"id": "string",
"code": "string",
"description": "string",
"type": "deal",
"settings": [ ],
"auto_apply": 0,
"left_amount": 0
}
}

Get auto apply vouchers

Get all active vouchers only auto apply

Responses

Response samples

200
404

Content type

application/json

{"status": "string",
"message": "string",
"data": {"id": "string",
"code": "string",
"description": "string",
"type": "deal",
"settings": [ ],
"auto_apply": 0,
"left_amount": 0
}
}

Get voucher terms

Get terms for active vouchers for specific store, only active and auto apply

Request Body schema: application/json

store_id

required

number

Store id

Responses

Request samples

Payload

Content type

application/json

{"store_id": 0
}

Response samples

200
400
404
422

Content type

application/json

{"status": "string",
"message": "string",
"data": {"code": "string",
"description": "string"
}
}