Skip to content
This repository was archived by the owner on Jan 23, 2023. It is now read-only.

Commit 68436d7

Browse files
committed
docs: add new endpoints
1 parent a54764e commit 68436d7

File tree

1 file changed

+54
-0
lines changed

1 file changed

+54
-0
lines changed

README.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,20 @@ A Magento 2 API Object Oriented wrapper for a Laravel application.
1919
- [API Usage](#api-usage)
2020
- [Available Methods](#available-methods)
2121
- [Admin Token](#admin-token)
22+
- [Bundle Products](#bundle-products)
2223
- [Carts](#carts)
2324
- [Categories](#categories)
2425
- [Customer Token](#customer-token)
2526
- [Customers](#customers)
2627
- [Guest Cart](#guest-cart)
28+
- [Orders](#orders)
2729
- [Product Attributes](#product-attributes)
2830
- [Product Link Types](#product-link-types)
2931
- [Products](#products)
3032
- [Schema](#schema)
3133
- [Source Items](#source-items)
34+
- [Sources](#sources)
35+
- [Stocks]($stocks)
3236
- [Custom Modules](#custom-modules)
3337

3438

@@ -85,6 +89,16 @@ Generate a admin token:
8589
Magento::api('integration')->adminToken($username, $password);
8690
```
8791

92+
<a id="bundle-products"></a>
93+
### Bundle Product Options (bundleProductOptionRepositoryV1)
94+
95+
`/V1/bundle-products/{sku}/options/all`
96+
97+
Get all options for bundle product.
98+
```php
99+
Magento::api('bundleProduct')->options($sku);
100+
```
101+
88102
#### Carts
89103

90104
`/V1/carts/mine`
@@ -197,6 +211,18 @@ Estimate shipping by address and return list of available shipping methods.
197211
Magento::api('guestCarts')->estimateShippingMethods($cartId);
198212
```
199213

214+
<a id="orders"></a>
215+
### Orders (salesOrderRepositoryV1)
216+
217+
Lists orders that match specified search criteria.
218+
219+
`/V1/orders`
220+
221+
Lists orders that match specified search criteria.
222+
```php
223+
Magento::api('orders')->all($pageSize = 50, $currentPage = 1, $filters = []);
224+
```
225+
200226
<a id="product-attributes"></a>
201227
### Product Attributes (catalogProductAttributeRepositoryV1)
202228

@@ -271,6 +297,34 @@ Get a list of paginated sort items (typically used for quantity retrieval):
271297
Magento::api('sourceItems')->all($pageSize = 50, $currentPage = 1, $filters = []);
272298
```
273299

300+
<a id="sources"></a>
301+
### Sources (inventoryApiSourcesRepositoryV1)
302+
303+
`/V1/inventory/sources`
304+
305+
Get a list of paginated sources.
306+
```php
307+
Magento::api('sources')->all($pageSize = 50, $currentPage = 1, $filters = []);
308+
```
309+
310+
`/V1/inventory/sources/{$name}`
311+
312+
Get a specified source.
313+
```php
314+
Magento::api('sources')->bySourceName($name);
315+
```
316+
317+
<a id="stocks"></a>
318+
319+
### Stocks (inventoryApiStocksRepositoryV1)
320+
321+
`/V1/inventory/stocks`
322+
323+
Get a list of paginated stocks.
324+
```php
325+
Magento::api('stocks')->all($pageSize = 50, $currentPage = 1, $filters = []);
326+
```
327+
274328
## Testing
275329

276330
``` bash

0 commit comments

Comments
 (0)