# What is Simple Store? [SimpleStore](https://simplestore.io/) is a hosted headless eCommerce platform that provides all the required back-end functionality to build a sophisticated and robust eCommerce experience. ## Support If you have any questions or require help using the platform, send us an email to # Portal The Portal provides a user interface to support the management of your entire store. Access the portal at: ![](/files/-M3pKRyatMfYhSn_z9vg) # Environments ### Live Mode and Test Mode # Configuring Your Store # Creating Your First Product ### Catalog Assess the **Catalog** screen in the console via the console navigation bar. Click **Add New**
### Add New Product Enter a Product Title and Description
Click **Submit** ### Details Specify a Sell and Retail Price (see [Pricing](/concepts/pricing)) Additional product **Details** can be specified including: * Categories (see [Categories](/concepts/categories)) * Collections (see [Collections](/concepts/collections))
### Inventory **Optional:** in the Inventory Tab specify a Sku (stock-keeping unit) and available quantity and minimum active quantity. For more detail see [Inventory](/concepts/inventory).
### Rewards *Where rewards capability is enabled* **Optional:** In the Rewards Tab specify if the Product can be redeemed for Points or Currency.
### Attributes **Optional:** Additional product attributes can be specified as Key/Value pairs in the **Attributes** Tab.
Click **Save** # QuickBuy Quick Buy is a plug and play solution enabling your business to become an eCommerce business - quick and simple. {% hint style="warning" %} **Pre-requisites for QuickBuy operations** * Product must be active * Price must be specified (e.g. >= 0) * Currency code specified for Store. * Stripe needs to be configured for Store. {% endhint %} To enable quick but navigate to the Product Details screen and click "Get Quick Buy Link" ![](/files/-M43WVoUL8lovy2bR3Ok) This will generate a quick buy url: ![](/files/-M4JJXaFVAUBs7CihdqV) Which you can post anywhere to sell your product: ![](/files/-M4JOtslhq8rOOKFUGgl) # Assets Simple store supports the upload, storage and management of assess (files) that can be associated with Products and Categories. Examples of assets include: jpg, gif, png, pdf. ### Portal View #### Accessing Assets Assess the Assets screen in the console via the console navigation bar.
#### Add New Asset Click Upload File to upload and create the new asset. ![](/files/-M5oIhZ8VDsS8ER2q-Mf) Specify a Title, Description and Access Permission. Access Permission allow an assets to be defined as Public or Private Drag and Drop the asset to upload.
Click **Submit**. #### Edit Assets Assets can be accessed by clicking on the main asset screen:
File Details can be edited.
Click **Save** to commit your modifications. Assets can be deleted by clicking the **Delete** button. ### Asset Properties #### Folders Assets can be stored in a hierarchy of folders. {% tabs %} {% tab title="Attributes" %} | Element | Description | | ------------ | ----------------------------------------------------------------------------------------------------------- | | folderId | Unique Identifer for the Folder | | version | An incremental version number tracking changes to the folder configuration | | name | Name | | parentId | A parent folder identifier to support the creation of a hierarchical/tree based structure of related folder | | attributes | Attributes are a list of Key/Value to support customisation of a folder | | {% endtab %} | | {% tab title="Sample Object" %} ``` { "folderId": "string", "version": "string", "name": "string", "parentId": "string", "attributes": {} } ``` {% endtab %} {% endtabs %} #### Files Files represent the range of assets that can be stored and managed. {% tabs %} {% tab title="Attributes" %} | Element | Description | | ---------------- | -------------------------------------------------------------------------- | | fileId | Unique Identifer for the File | | version | An incremental version number tracking changes to the folder configuration | | title | Title of Image | | description | Description | | contentType | Content-Type of file | | fileName | File Name | | length | File Length | | width | Width of File (images) | | height | Height of File (images) | | accessUrl | Access Url | | accessPermission | Access Permission | | attributes | Attributes are a list of Key/Value to support customisation of a folder | | isActive | Is Active | | folderId | Reference to Containing Folder Id | | edgeUrl | Edge Url | | {% endtab %} | | {% tab title="Sample Object" %} ``` { "fileId": "string", "version": "string", "title": "string", "description": "string", "contentType": "string", "fileName": "string", "length": 0, "width": 0, "height": 0, "accessUrl": "string", "accessPermission": 0, "attributes": {}, "isActive": true, "folderId": "string", "edgeUrl": "string" } ``` {% endtab %} {% endtabs %} # Image Resizing # Cart Simple Store supports a full ecommerce shopping cart object. ### Basic Cart Process
{% tabs %} {% tab title="Attributes" %} | Element | Desciption | | ---------------------- | ------------------------------------------------------------------- | | cartId | Unique Identifier for the Cart | | items\[] | An array of one or many items in the Cart | | items\[].productId | Unique Identifer for the Product (see [Product](/concepts/product)) | | items\[].slug | Product Slug | | items\[].title | Product Title | | items\[].description | Product Description | | items\[].quanity | Quantity of Product | | items\[].paymentMethod | Payment Method | | items\[].totalCurrency | Product Total in Currency | | items\[].totalPoints | Product Total in Points | | items\[].files\[] | See [Assets](/concepts/assets) | | items\[].attributes | One or more key/value pairs to support customisation of products | | currencyCode | ISO currency code | | shippingFee | Shipping Fee | | subTotalCurrency | Cart Total in Currency (excluding Shipping) | | totalCurrency | Cart Total in Currency | | totalPoints | Cart Total in Points | | attributes | One or more key/value pairs to support customisation of cart | | | | | {% endtab %} | | {% tab title="Sample Object" %} ``` { "cartId": "string", "items": [ { "productId": "string", "slug": "string", "title": "string", "description": "string", "quantity": 0, "paymentMethod": "CurrencyOnly", "totalCurrency": 0, "totalPoints": 0, "files": [ { "fileId": "string", "contentType": "string", "accessPermission": "string", "accessUrl": "string", "attributes": {}, "edgeUrl": "string" } ], "attributes": {} } ], "currencyCode": "string", "shippingFee": 0, "subTotalCurrency": 0, "totalCurrency": 0, "totalPoints": 0, "attributes": {} } ``` {% endtab %} {% endtabs %} # Categories Products can be assigned to one or more categories which classify products into groups which could represent: * Type of Product for example a "Toaster" category containing one or many Toasters. * Products belonging to a special offer for example a "Special Deals" category contain one or many products with special pricing. * Products assigned to be presented in a specific location within a channel, for example "Home Page Banner" for all products that are assigned to appear on a Banner on the Home Page of a website. ### Portal View #### Accessing Categories Assess the **Categories** screen in the console via the console navigation bar.
#### Add New Category Specified a Name for the category. Click **New Category** to create the new category.
#### Edit Categories Additional **Category Details** can be specified including: ![](/files/-M3pDX5RcJKVuQGRjD1r) Click **Save** to commit your modifications. ### Category Properties {% tabs %} {% tab title="Attributes" %} | Element | Description | | --------------- | ------------------------------------------------------------------------------------------------------ | | categoryId | Internal Identifier for the category | | name | Name of the category | | slug | A Url slug to access the category | | description | A Description for the category | | attributes | One or more key/value pairs | | parent Category | A parent category to support the creation of a hierarchical/tree based structure of related categories | | images | Image (assets) assigned to a category | | {% endtab %} | | {% tab title="Sample Object" %} ``` { "categoryId": "string", "version": "string", "slug": "string", "name": "string", "description": "string", "names": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "descriptions": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "parentId": "string", "parentName": "string", "itemCount": 0, "attributes": {}, "children": [ { "categoryId": "string", "name": "string", "slug": "string", "names": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" } } ], "totalChildren": 0, "sibling": [ { "categoryId": "string", "name": "string", "slug": "string", "names": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" } } ], "totalSibling": 0, "isActive": true, "files": [ { "fileId": "string", "contentType": "string", "accessPermission": "string", "accessUrl": "string", "attributes": {}, "edgeUrl": "string" } ] } ``` {% endtab %} {% endtabs %} # Configuration ``` { "defaultCurrencyCode": "string", "rewardsConversionRate": 0, "languages": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" } } ``` # Collections A collection represents a broad logical grouping of products. Examples of collections could be: * Winter Collection * Premium Collection ### Portal View #### View Collections Assess the **Collection** screen in the console via the console navigation bar.
#### Add New Collection Click **Add New** to create a new collection ![](/files/-M3pF68PdFXfMg0NkMYN) Specified a Name and Description for the collection. Click **Submit** to create the new collection. ![](/files/-M3pFi5xchck9J_wKqEG) #### Edit Collection Additional **Collection Details** can be specified including:
Click **Save** to commit your modifications. ### Collection Properties {% tabs %} {% tab title="Attributes" %} | Element | Description | | ------------ | -------------------------------------- | | collectionId | Internal Identifier for the collection | | name | Name of the collection | | slug | A Url slug to accese the collection | | description | A Description for the collection | | attributes | One or more key/value pairs | | {% endtab %} | | {% tab title="Sample Object" %} ``` { "collectionId": "string", "version": "string", "name": "string", "slug": "string", "description": "string", "names": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "descriptions": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "isActive": true, "totalItems": 0, "attributes": {} } ``` {% endtab %} {% endtabs %} # Customers The Customer object supports the storage of a defined set and custom attributes relating to your customers. ### Portal View #### Accessing Customers Assess the Customers screen in the console via the console navigation bar. ![](/files/-M5oRyu0PlytpNFOE6jQ) #### Add New Customers Click Add New to create a new customer. ![](/files/-M5oS5b69y0doNnxvWuC) Specify a First Name. Last Name, Display Name and Email Address.
Click **Submit**. #### Edit Customers Customers can be accessed by clicking on the main customer screen:
Customer Details can be edited.
Click **Save** to commit your modifications. Customers can be deleted by clicking the **Delete** button. ### Customer Properties {% tabs %} {% tab title="Attributes" %} | Element | Description | | ----------------------------- | -------------------------------------------------------------------------- | | customerId | A unique identifier for the Customer (Guid/UUID) | | version | A incremental version number tracking modifications to the Customer object | | firstName | Customer First Name | | lastName | Customer Last Name | | displayName | Customer Display Name | | emailAddress | Customer Email Address in | | phones\[] | An array of Phone numbers | | phones\[].Key | A unique identifier for the Phone Number (Guid/UUID) | | phones\[].Type | Unknown, Phone, Mobile | | phones\[].Country | ISO Country Code | | phones\[].NumberLocal | Phone Number in Local format | | phones\[].NumberInternational | Phone Number in International format | | addresses\[] | An array of address(es) | | addresses\[].Key | A unique identifier for the Address (Guid/UUID) | | addresses\[].Address1 | Address Line 1 | | addresses\[].Address2 | Address Line 2 | | addresses\[].Suburb | Suburb | | addresses\[].PostCode | Postal Code/Zip Code | | addresses\[].State | State/Province/Region | | addresses\[].Country | Country | | attributes | Attributes are a list of Key/Value to support customisation of a Customer | | {% endtab %} | | {% tab title="Sample Object" %} ``` { "customerId": "string", "version": "string", "firstName": "string", "lastName": "string", "displayName": "string", "emailAddress": "string", "phones": [ { "key": "string", "type": "Unknown", "country": "string", "numberLocal": "string", "numberInternational": "string" } ], "addresses": [ { "key": "string", "address1": "string", "address2": "string", "suburb": "string", "postcode": "string", "state": "string", "country": "string" } ], "attributes": {} } ``` {% endtab %} {% endtabs %} # Inventory Optionally SimpleStore supports the tracking of product inventory. ### Portal View ![](/files/-M3ur_g8fXpD-OCpKtvE) The following elements can be specified for management of inventory: ### Inventory Properties {% tabs %} {% tab title="Attributes" %} | Element | Description | | ----------------- | ------------------------------------------------------------------------------------------------------------------- | | sku | Stock-keeping unit of product | | availableQuantity | How many available in stock | | minActiveQuantity | If AvailableQuantity is below this value then the Product will not longer will be available (Status = Out Of Stock) | | grossWeight | Gross weight of the product | | trackInventory | Enable tracking of inventory (true\|false) | | {% endtab %} | | {% tab title="Sample Object" %} ``` { "sku": "string" "availableQuantity": number($double) "minActiveQuantity": number($double) "grossWeight": number($double) "trackInventory": boolean } ``` {% endtab %} {% endtabs %} | | | - | # Orders The Order object stores completed Orders. ### Portal View #### Accessing Orders Assess the Orders screen in the console via the console navigation bar. ![](/files/-M64_oUM6NDW-CFAVxpg) #### View Orders Orders can be accessed by clicking on the main order screen: ![](/files/-M64TnxFZjTnTtizJMw0) Click **Edit** to commit view the Order Detail modifications. Additional a summary of the order is visible by expanding the tree view. ![](/files/-M64U57l-7WtftudMePX) #### Order Details - General and Purchaser Details ![](/files/-M64Zifyv7AlahINIpmo) #### Order Details - Items ![](/files/-M64ZnA0P7BeTbsCx_yk) #### Order Details - Billing and Shipping Details ![](/files/-M64_7ylg9XR4hoh9ccU) ### Order Properties {% tabs %} {% tab title="Attributes" %} | Element | Description | | ------------------------------ | -------------------------------------------------------------------------- | | orderId | A unique identifier for the Order (Guid/UUID) | | version | A incremental version number tracking modifications to the Customer object | | status | The Order Status () | | createdOnUtc | Created in UTC time (2020-04-29T10:02:03.212Z) | | customerId | A unique identifier for the Customer (Guid/UUID) | | purchaserName | Purchaser Name | | purchaserContactNumberLocal | Purchaser Contact Number (local) | | purchaserEmail | Purchaser Email Address | | receiverName | Receiver Name | | receiverContactNumberLocal | Receiver Contact Number (local) | | receiverEmail | Receiver Email Address | | items\[] | An array of Items | | items\[].productId | A unique identifier for the Product (Guid/UUID) | | items\[].quantity | Quantity of Product | | items\[].sellPrice | Sell Price | | items\[].total | Total (Quantity x Sell Price) | | currencyCode | ISO currency code | | shippingFee | Shipping Fee | | subtotal | Total (excluding Shipping Fee) | | total | Total | | payments\[] | An array of payments | | payments\[].paymentId | A unique identifier for the Payment (Guid/UUID) | | payments\[].paidOnUtc | Paid in UTC time (2020-04-29T10:02:03.212Z) | | payments\[].type | Payment Type (Credit, Cash, Points) | | payments\[].status | Payment Status | | payments\[].paidAmount | Payment Amount | | payments\[].cancellationReason | Cancellation Reason | | payments\[].refundId | Redund Identifier | | payments\[].refundReason | Redund Reason | | payments\[].attributes | Attributes are a list of Key/Value to support customisation of a Payment | | totalPaid | Total Paid (Total of all Payments) | | attributes | Attributes are a list of Key/Value to support customisation of a Order | | {% endtab %} | | {% tab title="Sample Object" %} ``` { "orderId": "string", "version": "string", "status": "Created", "createdOnUtc": "2020-04-29T10:02:03.212Z", "customerId": "string", "purchaserName": "string", "purchaserContactNumberLocal": "string", "purchaserEmail": "string", "receiverName": "string", "receiverContactNumberLocal": "string", "receiverEmail": "string", "items": [ { "productId": "string", "title": "string", "quantity": 0, "sellPrice": 0, "total": 0 } ], "currencyCode": "string", "shippingFee": 0, "subtotal": 0, "total": 0, "payments": [ { "paymentId": "string", "paidOnUtc": "2020-04-29T10:02:03.212Z", "type": "Credit", "status": "Successful", "paidAmount": 0, "cancellationReason": "string", "refundId": "string", "refundReason": "string", "attributes": {} } ], "totalPaid": 0, "attributes": {} } ``` {% endtab %} {% endtabs %} # Payments API Only: reference Payment Detail in Order No Console
# Pricing Pricing of products comprise a specified base price and a dynamically calculated effective price. ### Portal View
### Base Price The pricing information that has been assigned to the product itself via the console/api. {% tabs %} {% tab title="Attributes" %} | Element | Description | | ------------ | ---------------------------------------------------------------------------------------------- | | currencyCode | ISO Currency code | | sellPrice | Is the advertised Price present to customer (excluding specials, discounts or other modifiers) | | retailPrice | Optional: Retail Price is the Recommended Retail Price (RRP) | | {% endtab %} | | {% tab title="Sample Object" %} ``` { "currencyCode": "string" "sellPrice": number($decimal) "retailPrice": number($decimal) "attributes": {...} } ``` {% endtab %} {% endtabs %} ### Effective Price The effective price is the calculated price of the product after specials, discount or other modifiers have been applied to the product. It is accessible as read only properties on the Catalog > Product API Responses # Product A Product represents something that can be purchased within the the Simple Store platform. The Product object comprises both a standard set of default fields along with a flexible model to extend the product to meet your customisation needs. The Product can be associated with Categories, Collection, Assets and Attributes. ### Portal View ![](/files/-M3usWqb-Mo8xWptoODv) ### Product Properties {% tabs %} {% tab title="Attributes" %} | Element | Description | | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | productId | Unique Identifer for the Product | | slug | A Url slug used to identify a product | | shortUrl | A globally unique id identifier (see [QuickBuy](/getting-started/quickbuy)) | | version | An incremental version number tracking changes to the Product configuration | | title | Default Title for the Product | | description | Default Description for the Product | | titles |

Dictionary (key, value) of alternate Titles other languages to support internationalisation (i18n) and localisation (l10n):