|
| 1 | +--- row |
| 2 | + |
| 3 | +<<< left |
| 4 | +# Welcome |
| 5 | + |
| 6 | +Welcome to FoxCommerce! The Fox Platform is a large and diverse set of modern services |
| 7 | +that allow you create next generation commerce experiences. |
| 8 | + |
| 9 | +<<< |
| 10 | + |
| 11 | +>>> right |
| 12 | +
|
| 13 | +#### API Reference Quick Links |
| 14 | +::: note |
| 15 | +[Authentication](reference/index.html#header-authentication) |
| 16 | +::: |
| 17 | +::: note |
| 18 | +[Errors](reference/index.html#header-errors) |
| 19 | +::: |
| 20 | +::: note |
| 21 | +[API.js](https://github.com/FoxComm/api-js) |
| 22 | +::: |
| 23 | + |
| 24 | +>>> |
| 25 | +
|
| 26 | +--- |
| 27 | + |
| 28 | +--- row |
| 29 | +<<< left |
| 30 | +# [API Reference](reference/index.html) |
| 31 | +See the API Reference for detailed information or the guides below for a tour |
| 32 | +of FoxCommerce features. |
| 33 | +<<< |
| 34 | + |
| 35 | +--- |
| 36 | + |
| 37 | +--- row |
| 38 | + |
| 39 | +<<< left |
| 40 | +# Guides |
| 41 | +## [Customers/Checkout Guide](customers/index.html) |
| 42 | +Learn about customer accounts, registration, and checkout. |
| 43 | + |
| 44 | +<img class='eimg' src="data/customers.png"/> |
| 45 | +<<< |
| 46 | + |
| 47 | +>>> right |
| 48 | +
|
| 49 | +<br></br> |
| 50 | +#### Registering a User |
| 51 | + |
| 52 | +Signup will register a user and return the user information and a JWT authorization token. |
| 53 | + |
| 54 | +``` javascript |
| 55 | +var fox = new FoxApi(); |
| 56 | +fox.auth.signup('john@doe.com', 'John Doe', 'password') |
| 57 | + .then(({jwt, customer}) => { |
| 58 | + fox.addAuth(jwt); |
| 59 | + //customers can also be guests. |
| 60 | + }); |
| 61 | +``` |
| 62 | +>>> |
| 63 | +
|
| 64 | +--- |
| 65 | + |
| 66 | +--- row |
| 67 | + |
| 68 | +<<< left |
| 69 | + |
| 70 | +## [Orders Guide](orders/index.html) |
| 71 | +Learn how to manage orders and process orders. |
| 72 | + |
| 73 | +<img class='eimg' src="data/orders.png"/> |
| 74 | + |
| 75 | +<<< |
| 76 | + |
| 77 | +>>> right |
| 78 | +
|
| 79 | +<br></br> |
| 80 | +#### Getting An Order |
| 81 | + |
| 82 | +``` javascript |
| 83 | +fox.orders.get('BR42443').then((resp) => { |
| 84 | + var order = resp.result; |
| 85 | + var referenceNumber = order.referenceNumber; |
| 86 | + //orders are read only except order state. |
| 87 | +}); |
| 88 | +``` |
| 89 | +>>> |
| 90 | +
|
| 91 | +--- |
| 92 | + |
| 93 | +--- row |
| 94 | + |
| 95 | +<<< left |
| 96 | +## [Products Guide](products/index.html) |
| 97 | +Learn about products, variants, and SKUs. |
| 98 | + |
| 99 | +<img class='eimg' src="data/products.png"/> |
| 100 | +<<< |
| 101 | + |
| 102 | +>>> right |
| 103 | +
|
| 104 | +<br></br> |
| 105 | +#### Getting a Product |
| 106 | + |
| 107 | +Along with the product id, you must specify which view you want. |
| 108 | + |
| 109 | +``` javascript |
| 110 | +fox.products.one('default',1343).then( (product) => { |
| 111 | + var title = product.attributes.title; |
| 112 | + //attributes are typed and customizable. |
| 113 | +}); |
| 114 | +``` |
| 115 | +>>> |
| 116 | +
|
| 117 | +--- |
| 118 | + |
| 119 | +--- row |
| 120 | + |
| 121 | +<<< left |
| 122 | +## [Inventory Guide](inventory/index.html) |
| 123 | + |
| 124 | +Learn about how to track inventory and make products available to customers. |
| 125 | + |
| 126 | +<img class='eimg' src="data/inventory.png"/> |
| 127 | +<<< |
| 128 | + |
| 129 | +--- |
| 130 | + |
| 131 | +--- row |
| 132 | + |
| 133 | +<<< left |
| 134 | +## [Search Guide](search/index.html) |
| 135 | + |
| 136 | +Learn about searching products, customers, and orders. Learn how to create |
| 137 | +search queries using the query language. |
| 138 | + |
| 139 | +<img class='eimg' src="data/search.png"/> |
| 140 | +<<< |
| 141 | + |
| 142 | +--- |
| 143 | + |
| 144 | +--- row |
| 145 | + |
| 146 | +<<< left |
| 147 | +## [Merchandising Guide](merchandising/index.html) |
| 148 | + |
| 149 | +Learn about offering discounts and promotions to your customers to increase conversion. |
| 150 | + |
| 151 | +<img class='eimg' src="data/promotions.png"/> |
| 152 | +<<< |
| 153 | + |
| 154 | +--- |
| 155 | + |
| 156 | +--- row |
| 157 | + |
| 158 | +<<< left |
| 159 | + |
| 160 | +## [Personalization Guide](personalization/index.html) |
| 161 | + |
| 162 | +Product recommendations, targeted messaging, and product reviews. |
| 163 | + |
| 164 | +<img class='eimg' src="data/recommendations.png"/> |
| 165 | + |
| 166 | +<<< |
| 167 | + |
| 168 | +--- |
| 169 | + |
| 170 | +--- row |
| 171 | + |
| 172 | +<<< left |
| 173 | + |
| 174 | +## [Events Guide](events/index.html) |
| 175 | + |
| 176 | +Understand and react to what is happening in the system. |
| 177 | + |
| 178 | +<img class='eimg' src="data/events.png"/> |
| 179 | + |
| 180 | +<<< |
| 181 | + |
| 182 | +--- |
| 183 | + |
| 184 | +--- row |
| 185 | + |
| 186 | +<<< left |
| 187 | + |
| 188 | +## [Extending Guide](extending/index.html) |
| 189 | + |
| 190 | +Extending the storefront and back office. |
| 191 | + |
| 192 | +<img class='eimg' src="data/extending.png"/> |
| 193 | + |
| 194 | +<<< |
| 195 | + |
| 196 | +--- |
| 197 | + |
| 198 | +--- row |
| 199 | + |
| 200 | +<<< left |
| 201 | +## [Channels Guide](channels/index.html) |
| 202 | + |
| 203 | +Learn about selling your products on amazon and managing orders. |
| 204 | + |
| 205 | +<img class='eimg' src="data/amazon.png"/> |
| 206 | + |
| 207 | +<<< |
| 208 | + |
| 209 | +--- |
| 210 | + |
| 211 | +<!-- include(support.md) --> |
0 commit comments