Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions developer-portal/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ clean:
prep:
npm install
cd node_modules/aglio-theme-fox && npm install
rsync -av node_modules/aglio-theme-fox/templates/assets/ content/assets/

build:
$(call header, Building)
Expand All @@ -36,4 +37,7 @@ publish: build
firebase use production
firebase deploy

serve: build
firebase serve

.PHONY: prep clean build test docker docker-push publish
211 changes: 211 additions & 0 deletions developer-portal/content/home.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,211 @@
--- row

<<< left
# Welcome

Welcome to FoxCommerce! The Fox Platform is a large and diverse set of modern services
that allow you create next generation commerce experiences.

<<<

>>> right

#### API Reference Quick Links
::: note
[Authentication](reference/index.html#header-authentication)
:::
::: note
[Errors](reference/index.html#header-errors)
:::
::: note
[API.js](https://github.com/FoxComm/api-js)
:::

>>>

---

--- row
<<< left
# [API Reference](reference/index.html)
See the API Reference for detailed information or the guides below for a tour
of FoxCommerce features.
<<<

---

--- row

<<< left
# Guides
## [Customers/Checkout Guide](customers/index.html)
Learn about customer accounts, registration, and checkout.

<img class='eimg' src="data/customers.png"/>
<<<

>>> right

<br></br>
#### Registering a User

Signup will register a user and return the user information and a JWT authorization token.

``` javascript
var fox = new FoxApi();
fox.auth.signup('[email protected]', 'John Doe', 'password')
.then(({jwt, customer}) => {
fox.addAuth(jwt);
//customers can also be guests.
});
```
>>>

---

--- row

<<< left

## [Orders Guide](orders/index.html)
Learn how to manage orders and process orders.

<img class='eimg' src="data/orders.png"/>

<<<

>>> right

<br></br>
#### Getting An Order

``` javascript
fox.orders.get('BR42443').then((resp) => {
var order = resp.result;
var referenceNumber = order.referenceNumber;
//orders are read only except order state.
});
```
>>>

---

--- row

<<< left
## [Products Guide](products/index.html)
Learn about products, variants, and SKUs.

<img class='eimg' src="data/products.png"/>
<<<

>>> right

<br></br>
#### Getting a Product

Along with the product id, you must specify which view you want.

``` javascript
fox.products.one('default',1343).then( (product) => {
var title = product.attributes.title;
//attributes are typed and customizable.
});
```
>>>

---

--- row

<<< left
## [Inventory Guide](inventory/index.html)

Learn about how to track inventory and make products available to customers.

<img class='eimg' src="data/inventory.png"/>
<<<

---

--- row

<<< left
## [Search Guide](search/index.html)

Learn about searching products, customers, and orders. Learn how to create
search queries using the query language.

<img class='eimg' src="data/search.png"/>
<<<

---

--- row

<<< left
## [Merchandising Guide](merchandising/index.html)

Learn about offering discounts and promotions to your customers to increase conversion.

<img class='eimg' src="data/promotions.png"/>
<<<

---

--- row

<<< left

## [Personalization Guide](personalization/index.html)

Product recommendations, targeted messaging, and product reviews.

<img class='eimg' src="data/recommendations.png"/>

<<<

---

--- row

<<< left

## [Events Guide](events/index.html)

Understand and react to what is happening in the system.

<img class='eimg' src="data/events.png"/>

<<<

---

--- row

<<< left

## [Extending Guide](extending/index.html)

Extending the storefront and back office.

<img class='eimg' src="data/extending.png"/>

<<<

---

--- row

<<< left
## [Channels Guide](channels/index.html)

Learn about selling your products on amazon and managing orders.

<img class='eimg' src="data/amazon.png"/>

<<<

---

<!-- include(support.md) -->
Loading