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

Commit

Permalink
docs: 📝 tweak documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ahinkle committed Sep 24, 2021
1 parent 4bed8cb commit 0c82920
Show file tree
Hide file tree
Showing 3 changed files with 206 additions and 8 deletions.
201 changes: 201 additions & 0 deletions .idea/workspace.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 3 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -356,14 +356,10 @@ Magento::api('orders')->show($orderId);
```

`/V1/orders`

Updates an order specified by the entity id within the $body:
https://magento.redoc.ly/2.4.3-admin/tag/orders#operation/salesOrderRepositoryV1SavePost
Performs persist operations for a specified order.
```php
$body = [
'entity_id' => '', // required
// ... attributes to update
];
Magento::api('orders')->edit($body);
Magento::api('orders')->edit($entity = []);
```


Expand Down
3 changes: 2 additions & 1 deletion src/Api/Orders.php
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,8 @@ public function show($orderId)
}

/**
* Edits and saves an order using the specified entity id within the body.
* Performs persist operations for a specified order.
* @see https://magento.redoc.ly/2.4.3-admin/tag/orders/#operation/salesOrderRepositoryV1SavePost
*
* @param array $entity
* @return array
Expand Down

0 comments on commit 0c82920

Please sign in to comment.