|
|
|
### Running
|
|
|
|
``` ruby
|
|
|
|
ThreeDeeCart::Order.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
|
|
|
|
|
|
|
|
**startFrom** -
|
|
|
|
boolean, If startFrom is true and invoiceNum is specified, the web service will return orders >= invoiceNum. If startFrom is false and invoiceNum is specified, the web service will return just the specified order.
|
|
|
|
If invoiceNum is not specified, this parameter will be ignored.
|
|
|
|
|
|
|
|
invoiceNum -
|
|
|
|
Search for specific invoice number.
|
|
|
|
|
|
|
|
status -
|
|
|
|
Search orders by status.
|
|
|
|
|
|
|
|
dateFrom -
|
|
|
|
Search orders that were placed after specified date. Must be in mm/dd/yyyy format.
|
|
|
|
|
|
|
|
dateTo -
|
|
|
|
Search orders that were placed before specified date. Must be in mm/dd/yyyy format.
|
|
|
|
|
|
|
|
### Example
|
|
|
|
``` ruby
|
|
|
|
ThreeDeeCart::Order.find({storeURL: "http://www.3dcart.com", startNum: 10, batchSize: 1})
|
|
|
|
``` |
|
|
\ No newline at end of file |