Module: Orders

Included in:
Ecommerce
Defined in:
lib/user/ecommerce/orders.rb,
lib/contact/ecommerce/orders.rb

Instance Method Summary collapse

Instance Method Details

#add_item_to_shopping_cart(data, options = nil) ⇒ Object

Add Item To Shopping Cart.

Add an item into a shopping cart.

Parameters

data

(Hash) – Data to be submitted.

Example

data = {
  quantity: 1,
  sku_id: 1,
  price_list_id: 1
}
@data = @mints_contact.add_item_to_shopping_cart(data)



130
131
132
 
# File 'lib/contact/ecommerce/orders.rb', line 130

def add_item_to_shopping_cart(data, options = nil)
  @client.raw('post', '/ecommerce/shopping-cart', options, data_transform(data), @contact_v1_url)
end

#create_order(data) ⇒ Object

Create Order.

Create a order with data.

Parameters

data

(Hash) – Data to be submitted.

Example

data = {
  order_template_id: 1,
  order_status_id: 1,
  sales_channel_id: 1
}
@data = @mints_pub.create_order(data)



93
94
95
 
# File 'lib/user/ecommerce/orders.rb', line 93

def create_order(data, options = nil)
  @client.raw('post', '/ecommerce/orders', options, data_transform(data))
end

#delete_orders(data) ⇒ Object

Delete orders.

Delete orders.

Parameters

data

(Hash) – Data to be submitted.

Example

data = { ids: [ 18 ] }
@data = @mints_user.delete_orders(data)



29
30
31
32
 
# File 'lib/user/ecommerce/orders.rb', line 29

def delete_orders(data)
  # TODO: Inform method should return another response like 'success'
  @client.raw('delete', '/ecommerce/orders/delete', nil, data_transform(data))
end

#detach_order_item_from_order_item_group(order_item_id, group_id) ⇒ Object

TODO: No tested

Detach Order Item From Order Item Group.

Detach an order item from an order item group.

Parameters

orderI_iemI_i

(Integer) – Order item id.

group_id

(Integer) – Order items group id.



199
200
201
202
 
# File 'lib/user/ecommerce/orders.rb', line 199

def detach_order_item_from_order_item_group(order_item_id, group_id)
  # TODO: Research use
  @client.raw('put', "/ecommerce/order-items/detach/#{order_item_id}/order-items-groups/#{group_id}")
end

#duplicate_order(order_id, data) ⇒ Object

Duplicate order.

Duplicate an order.

Parameters

order_id

(Integer) – Order id.

data

(Hash) – Data to be submitted.



15
16
17
18
 
# File 'lib/user/ecommerce/orders.rb', line 15

def duplicate_order(order_id, data)
  # FIXME: Doesnt read options from data and sale_price_cents column doesnt have to be null
  @client.raw('post', "/ecommerce/orders/duplicate/#{order_id}", nil, data)
end

#get_my_shopping_cart(options = nil) ⇒ Object

Get My Shopping Cart.

Get a collection of items in the shopping cart.

Example

@data = @mints_contact.get_my_shopping_cart

FIXME: This method returns a nil data.



112
113
114
 
# File 'lib/contact/ecommerce/orders.rb', line 112

def get_my_shopping_cart(options = nil)
  @client.raw('get', '/ecommerce/my-shopping-cart', options, nil, @contact_v1_url)
end

#get_order(id, options = nil) ⇒ Object

Get Order.

Get an order info.

Parameters

id

(Integer) – Order id.

options

(Hash) – List of Resource Collection Options shown above can be used as parameter.

First Example

@data = @mints_pub.get_product(25)

Second Example

options = {
  fields: 'title'
}
@data = @mints_pub.get_product(25, options)



77
78
79
 
# File 'lib/user/ecommerce/orders.rb', line 77

def get_order(id, options = nil)
  @client.raw('get', "/ecommerce/orders/#{id}", options)
end

#get_order_item(id, options = nil) ⇒ Object

Get order item.

Get a order item info.

Parameters

id

(Integer) – Order item id.

options

(Hash) – List of Resource Collection Options shown above can be used as parameter.

First Example

@data = @mints_user.get_order_item(1)

Second Example

options = { fields: 'id' }
@data = @mints_user.get_order_item(1, options)



247
248
249
 
# File 'lib/user/ecommerce/orders.rb', line 247

def get_order_item(id, options = nil)
  @client.raw('get', "/ecommerce/order-items/#{id}", options)
end

#get_order_items(options = nil) ⇒ Object

Get order items.

Get a collection of order items.

Parameters

options

(Hash) – List of Resource Collection Options shown above can be used as parameter.

First Example

@data = @mints_user.get_order_items

Second Example

options = { fields: "id" }
@data = @mints_user.get_order_items(options)



229
230
231
232
 
# File 'lib/user/ecommerce/orders.rb', line 229

def get_order_items(options = nil)
  # FIXME: CaliRouter POST method not supported.
  @client.raw('get', '/ecommerce/order-items', options)
end

#get_order_items_support_data ⇒ Object

Get order items support data.

Get support data used in order items.

Example

@data = @mints_user.get_order_items_support_data



187
188
189
 
# File 'lib/user/ecommerce/orders.rb', line 187

def get_order_items_support_data
  @client.raw('get', '/ecommerce/order-items/support-data')
end

#get_order_template(id, options = nil) ⇒ Object

Get order template.

Get a order template info.

Parameters

id

(Integer) – Order template id.

options

(Hash) – List of Resource Collection Options shown above can be used as parameter.

First Example

@data = @mints_user.get_order_template(1)

Second Example

options = { fields: 'title' }
@data = @mints_user.get_order_template(1, options)



158
159
160
 
# File 'lib/user/ecommerce/orders.rb', line 158

def get_order_template(id, options = nil)
  @client.raw('get', "/ecommerce/order-templates/#{id}", options)
end

#get_order_template_support_data(id) ⇒ Object

Get order template support data.

Get support data from a order template.

Parameters

id

(Integer) – Order template id.

Example

@data = @mints_user.get_order_template_support_data(1)



125
126
127
 
# File 'lib/user/ecommerce/orders.rb', line 125

def get_order_template_support_data(id)
  @client.raw('get', "/ecommerce/order-templates/support-data/#{id}")
end

#get_order_templates(options = nil) ⇒ Object

Get order templates.

Get a collection of order templates.

Parameters

options

(Hash) – List of Resource Collection Options shown above can be used as parameter.

First Example

@data = @mints_user.get_order_templates

Second Example

options = { fields: 'title' }
@data = @mints_user.get_order_templates(options)



141
142
143
 
# File 'lib/user/ecommerce/orders.rb', line 141

def get_order_templates(options = nil)
  @client.raw('get', '/ecommerce/order-templates', options)
end

#get_orders(options = nil, use_post = true) ⇒ Object

Get Orders.

Get a collection of orders.

Parameters

options

(Hash) – List of Resource Collection Options shown above can be used as parameter.

use_post

(Boolean) – Variable to determine if the request is by ‘post’ or ‘get’ functions.

First Example

@data = @mints_pub.get_orders

Second Example

options = { fields: 'title' }
@data = @mints_pub.get_orders(options)

Third Example

options = { fields: 'title' }
@data = @mints_pub.get_orders(options, false)



60
61
62
 
# File 'lib/user/ecommerce/orders.rb', line 60

def get_orders(options = nil, use_post = true)
  get_query_results('/ecommerce/orders', options, use_post)
end

#get_orders_support_data ⇒ Object

Get orders support data.

Get support data used in orders.

Example

@data = @mints_user.get_orders_support_data



39
40
41
 
# File 'lib/user/ecommerce/orders.rb', line 39

def get_orders_support_data
  @client.raw('get', '/ecommerce/orders/support-data')
end

#update_order(id, data) ⇒ Object

Update Order.

Update an order info.

Parameters

id

(Integer) – Order Id

data

(Hash) – Data to be submitted.

FIXME: This method doesnt update an order.



109
110
111
 
# File 'lib/user/ecommerce/orders.rb', line 109

def update_order(id, data, options = nil)
  @client.raw('put', "/ecommerce/orders/#{id}", options, data_transform(data))
end

#update_order_item(id, data) ⇒ Object

Update order item.

Update a order item info.

Parameters

id

(Integer) – Order item id.

data

(Hash) – Data to be submitted.

Example

data = { title: 'No title in order items' }
@data = @mints_user.update_order_item(1, data)



261
262
263
264
 
# File 'lib/user/ecommerce/orders.rb', line 261

def update_order_item(id, data)
  # TODO: Research what can update
  @client.raw('put', "/ecommerce/order-items/#{id}", nil, data_transform(data))
end

#update_order_item_from_order_item_group(order_item_id, group_id, data) ⇒ Object

TODO: No tested

Update Order Item From Order Item Group.

Update an order item data from an order item group.

Parameters

orderI_iemI_i

(Integer) – Order item id.

group_id

(Integer) – Order items group id.



211
212
213
214
215
 
# File 'lib/user/ecommerce/orders.rb', line 211

def update_order_item_from_order_item_group(order_item_id, group_id, data)
  # TODO: Research use
  url = "/ecommerce/order-items/update/#{order_item_id}/order-items-groups/#{group_id}"
  @client.raw('put', url, nil, data_transform(data))
end

#update_order_template(id, data) ⇒ Object

Update order template.

Update a order template info.

Parameters

id

(Integer) – Order template id.

data

(Hash) – Data to be submitted.

Example

data = {
  title: 'Inventory Increase'
}
@data = @mints_user.update_order_template(12, data)



174
175
176
 
# File 'lib/user/ecommerce/orders.rb', line 174

def update_order_template(id, data)
  @client.raw('put', "/ecommerce/order-templates/#{id}", nil, data_transform(data))
end