Skip to content

Commit fe44964

Browse files
committed
Bullet list for examples
1 parent 3f9cfbf commit fe44964

File tree

1 file changed

+17
-16
lines changed

1 file changed

+17
-16
lines changed

README.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Install with Composer
77
composer require phpclassic/php-shopify
88
```
99

10-
>You may not be able to install using composer until a stable version is available. For the time being you can download the zip file and put the extracted folder into `vendor/phpclassic` folder and add the following code into your root `composer.json` file:
10+
>You may not be able to install using composer until a stable version is available. For the time being you can download the zip file, put the extracted folder into `vendor/phpclassic` folder and add the following code into your root `composer.json` file:
1111
1212
```
1313
"autoload": {
@@ -110,21 +110,22 @@ $shopify = new PHPShopify\ShopifySDK($config);
110110
##### Now you can do `get()`, `post()`, `put()`, `delete()` calling the resources in the object oriented way. All resources are named as same as it is named in shopify API reference. (See the resource map below.)
111111
> All the requests returns an array (which can be a single resource array or an array of multiple resources) if succeeded. When no result is expected (for example a DELETE request), an empty array will be returned.
112112
113-
Get all product list (GET request)
113+
- Get all product list (GET request)
114114

115115
```php
116116
$products = $shopify->Product->get();
117117
```
118118

119-
Get any specific product with ID (GET request)
119+
- Get any specific product with ID (GET request)
120120

121121
```php
122122
$productID = 23564666666;
123123
$product = $shopify->Product($productID)->get();
124124
```
125125

126126
You can also filter the results by using the url parameters (as specified by Shopify API Reference for each specific resource).
127-
For example get the list of cancelled orders after a specified date and time (and `fields` specifies the data columns for each row to be rendered) :
127+
128+
- For example get the list of cancelled orders after a specified date and time (and `fields` specifies the data columns for each row to be rendered) :
128129

129130
```php
130131
$params = array(
@@ -136,7 +137,7 @@ $params = array(
136137
$orders = $shopify->Order->get($params);
137138
```
138139

139-
Create a new order (POST Request)
140+
- Create a new order (POST Request)
140141

141142
```php
142143
$order = array (
@@ -153,7 +154,7 @@ $order = array (
153154
$shopify->Order->post($order);
154155
```
155156

156-
Update an order (PUT Request)
157+
- Update an order (PUT Request)
157158

158159
```php
159160
$updateInfo = array (
@@ -163,7 +164,7 @@ $updateInfo = array (
163164
$shopify->Order($orderID)->put($order);
164165
```
165166

166-
Remove a WebHook (DELETE request)
167+
- Remove a WebHook (DELETE request)
167168

168169
```php
169170
$webHookID = 453487303;
@@ -175,14 +176,14 @@ $shopify->WebHook($webHookID)->delete());
175176
###The child resources can be used in a nested way.
176177
> You must provide the ID of the parent resource when trying to get any child resource
177178
178-
For example, get the images of a product (GET request)
179+
- For example, get the images of a product (GET request)
179180

180181
```php
181182
$productID = 23564666666;
182183
$productImages = $shopify->Product($productID)->Image->get();
183184
```
184185

185-
Add a new address for a customer (POST Request)
186+
- Add a new address for a customer (POST Request)
186187

187188
```php
188189
$address = array(
@@ -201,7 +202,7 @@ $customerID = 4425749127;
201202
$shopify->Customer($customerID)->Address->post($address);
202203
```
203204

204-
Create a fulfillment event (POST request)
205+
- Create a fulfillment event (POST request)
205206

206207
```php
207208
$fulfillmentEvent = array(
@@ -211,7 +212,7 @@ $fulfillmentEvent = array(
211212
$shopify->Order($orderID)->Fulfillment($fulfillmentID)->Event->post($fulfillmentEvent);
212213
```
213214

214-
Update a Blog article (PUT request)
215+
- Update a Blog article (PUT request)
215216

216217
```php
217218
$blogID = 23564666666;
@@ -225,7 +226,7 @@ $updateArtilceInfo = array(
225226
$shopify->Blog($blogID)->Article($articleID)->put($updateArtilceInfo);
226227
```
227228

228-
Delete any specific article from a specific blog (DELETE request)
229+
- Delete any specific article from a specific blog (DELETE request)
229230

230231
```php
231232
$blogArticle = $shopify->Blog($blogID)->Article($articleID)->delete();
@@ -291,23 +292,23 @@ Some resources are available directly, some resources are only available through
291292
- SmartCollection -> [Event](https://help.shopify.com/api/reference/event/)
292293
- [Theme](https://help.shopify.com/api/reference/theme)
293294
- Theme -> [Asset](https://help.shopify.com/api/reference/asset/)
294-
- [User](https://help.shopify.com/api/reference/user) _(read only, Shopify Plus Only_
295+
- [User](https://help.shopify.com/api/reference/user) _(read only, Shopify Plus Only)_
295296
- [Webhook](https://help.shopify.com/api/reference/webhook)
296297

297298
### Custom Actions
298299
There are several action methods which can be called without calling the `get()`, `post()`, `put()`, `delete()` methods directly, but eventually results in a custom call to one of those methods.
299300

300-
For example, get count of total projects
301+
- For example, get count of total projects
301302
```php
302303
$productCount = $shopify->Product->count();
303304
```
304305

305-
Make an address default for the customer.
306+
- Make an address default for the customer.
306307
```php
307308
$shopify->Customer($customerID)->Address($addressID)->makeDefault();
308309
```
309310

310-
Search for customers with keyword "Bob" living in country "United States".
311+
- Search for customers with keyword "Bob" living in country "United States".
311312
```php
312313
$shopify->Customer->search("Bob country:United States");
313314
```

0 commit comments

Comments
 (0)