Skip to content
This repository has been archived by the owner on Aug 14, 2024. It is now read-only.

readme fix: Shipment.all – pass parameters as a hash #152

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
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: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,11 +81,11 @@ shipment.tracking_url # -> http://track.shipcloud.io/uzdgu22z3ed12
You can get a list of all shipments from the shipcloud platform. Shipments can be filtered by providing optional parameters. For more information and a list of valid parameters see *[shipcloud API documentation on Shipments Index](https://developers.shipcloud.io/reference/#getting-a-list-of-shipments)*

```ruby
Shipcloud::Shipment.all(
Shipcloud::Shipment.all({
carrier: 'ups',
per_page: 25,
page: 2
)
})
```

`Shipment#all` will return an array of `Shipcloud::Shipment` objects, matching the given parameters.
Expand Down