# qb-shops

## Introduction

* Works in conjunction with [qb-inventory](/qbcore-documentation/qbcore-resources/qb-inventory.md) to let players buy items
* Includes delivery system for players to earn money while refilling stock of shop

## Creating a Shop

{% hint style="warning" %}
Options highlighted in yellow are optional!
{% endhint %}

### Defining Products

You can define a table of items inside a unique product list with multiple options available. The index of our table of items will be our unique product list name that we can use later so make sure to keep them different! Let's go over what needs to be included in our product list

* product list: `string`
* name: `string`
* amount: `number`
* <mark style="color:yellow;">info</mark>: `table`
* <mark style="color:yellow;">requiredJob</mark>: `table | string`
* <mark style="color:yellow;">requiredGang</mark>: `table | string`
* <mark style="color:yellow;">requiredGrade</mark>: `number`
* <mark style="color:yellow;">requiredLicense</mark>: `table | string`

#### Example:

```lua
['normal'] = {
    { name = 'sandwich',      price = 2,   amount = 50, },
    { name = 'water_bottle',  price = 2,   amount = 50, info = { quality = 100 } },
    { name = 'kurkakola',     price = 2,   amount = 50, requiredJob = 'police' },
    { name = 'twerks_candy',  price = 2,   amount = 50, requiredGang = 'ballas' },
    { name = 'kurkakola',     price = 2,   amount = 50, requiredJob = { 'police', 'ambulance' } },
    { name = 'twerks_candy',  price = 2,   amount = 50, requiredGang = { 'ballas', 'lostmc' } },
    { name = 'snikkel_candy', price = 2,   amount = 50, requiredGrade = 3 },
    { name = 'sandwich',      price = 2,   amount = 50, requiredLicense = 'weapon' },
    { name = 'sandwich',      price = 2,   amount = 50, requiredLicense = { 'weapon', 'driver' } },
},
```

{% hint style="warning" %}
When using a table for requirements, they are EITHER/OR and not both. So if we add police and ambulance as requirements, you will not need both jobs, only one of them!
{% endhint %}

### Defining Locations

You can define a list of shops which are indexed by a unique identifier. These identifier's must be different because it allows for the restocking of the shop if it's set to true.

* label: `string`
* products: `table`
* coords: `vector`
* delivery: `vector`
* <mark style="color:yellow;">ped</mark>: `string`
* <mark style="color:yellow;">scenario</mark>: `string`
* <mark style="color:yellow;">radius</mark>: `float`
* <mark style="color:yellow;">targetIcon</mark>: `string`
* <mark style="color:yellow;">targetLabel</mark>: `string`
* <mark style="color:yellow;">showblip</mark>: `boolean`
* <mark style="color:yellow;">blipsprite</mark>: `number`
* <mark style="color:yellow;">blipscale</mark>: `float`
* <mark style="color:yellow;">blipcolor</mark>: `number`
* <mark style="color:yellow;">radius</mark>: `float`
* <mark style="color:yellow;">useStock</mark>: `boolean`
* <mark style="color:yellow;">requiredJob</mark>: `string | table`
* <mark style="color:yellow;">requiredGang</mark>: `string | table`
* <mark style="color:yellow;">requiredItem</mark>: `string | table`

Example:

```lua
['247supermarket'] = {
    ['label'] = '24/7 Supermarket',
    ['products'] = Config.Products['normal'],
    ['coords'] = vector4(24.47, -1346.62, 29.5, 271.66),
    ['delivery'] = vector4(26.45, -1315.51, 29.62, 0.07),
    ['ped'] = 'mp_m_shopkeep_01',
    ['scenario'] = 'WORLD_HUMAN_STAND_MOBILE',
    ['targetIcon'] = 'fas fa-shopping-basket',
    ['targetLabel'] = 'Open Shop',
    ['showblip'] = true,
    ['blipsprite'] = 52,
    ['blipscale'] = 0.6,
    ['blipcolor'] = 0,
    ['radius'] = 1.5,
    ['useStock'] = true,
    ['requiredJob'] = 'police', -- string
    ['requiredJob'] = { ['mechanic'] = 4 }, -- table
    ['requiredGang'] = 'ballas', -- string
    ['requiredGang'] = { ['ballas'] = 4 }, -- table
    ['requiredItem'] = 'lockpick', -- string
    ['requiredItem'] = { 'lockpick', 'sandwich' } -- table
},
```

{% hint style="danger" %}
When setting `requiredJob`, `requiredGang` or `requiredItem` do not use both string and table methods, only choose one!
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.qbcore.org/qbcore-documentation/qbcore-resources/qb-shops.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.