Method: BaseCRM::OrdersService#where

Defined in:

lib/basecrm/services/orders_service.rb

#where(options = {}) ⇒ Array<Order>

Retrieve all orders

get ‘/orders’

Returns all orders available to the user according to the parameters provided

Parameters:

• options (Hash) (defaults to: {}) —

  Search options

Options Hash (options):

• :ids (String) —

  Comma-separated list of order IDs to be returned in a request.

• :deal_id (Integer) —

  ID of the deal order is associated to.

• :page (Integer) — default: 1 —

  Page number to start from. Page numbering starts at 1, and omitting the ‘page` parameter will return the first page.

• :per_page (Integer) — default: 25 —

  Number of records to return per page. Default limit is 25 and the maximum number that can be returned is 100.

• :sort_by (String) — default: id:asc —

  A field to sort by. Default ordering is ascending. If you want to change the sort ordering to descending, append ‘:desc` to the field e.g. `sort_by=value:desc`.

Returns:

• (Array<Order>) —

  The list of Orders for the first page, unless otherwise specified.

# File 'lib/basecrm/services/orders_service.rb', line 34

def where(options = {})
  _, _, root = @client.get("/orders", options)

  root[:items].map{ |item| Order.new(item[:data]) }
end