|
|
|
### Running
|
|
|
|
``` ruby
|
|
|
|
ThreeDeeCart::Customer.find(options)
|
|
|
|
```
|
|
|
|
|
|
|
|
### Available Options
|
|
|
|
Bold parameters are required
|
|
|
|
**storeURL**
|
|
|
|
3dCart Store URL from which the information will be requested. i.e.: www.3dcart.com
|
|
|
|
|
|
|
|
**batchSize** -
|
|
|
|
Number of records to pull. Range: 1 to 100.
|
|
|
|
|
|
|
|
**startNum** -
|
|
|
|
Position to start the search. Range: 1 to x
|
|
|
|
|
|
|
|
customersFilter -
|
|
|
|
Comma delimited string with zero or more search parameters.
|
|
|
|
Allowed parameters: firstname,lastname, email, countrycode, statecode, city, phone.
|
|
|
|
i.e.: `firstname=John,email=john@email.com, countrycode=US,statecode=FL,city=Margate`
|
|
|
|
|
|
|
|
### Example
|
|
|
|
``` ruby
|
|
|
|
ThreeDeeCart::Customer.find({storeURL: "http://www.3dcart.com", startNum: 10, batchSize: 1})
|
|
|
|
``` |
|
|
\ No newline at end of file |