Module: Orders

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

Instance Method Summary collapse

Instance Method Details

#add_order_line_item(order_id, data) ⇒ Object

Add order line item.

Add a line item to an order.

Parameters

order_id

(Integer) – Order id.

data

(Hash) – Data to be submitted.

Example

data = {
  product_id: 1,
  price: 10.99,
  quantity: 2
}
@data = @cxf_user.add_order_line_item(1, data)



104
105
106
 
# File 'lib/user/ecommerce/orders.rb', line 104

def add_order_line_item(order_id, data)
  @client.raw('post', "/ecommerce/orders/#{order_id}/line-item", nil, data_transform(data))
end

#change_order_status(order_id, data) ⇒ Object

Change order status.

Change order status.

Parameters

order_id

(Integer) – Order id.

data

(Hash) – Data to be submitted.

Example

data = {
  order_status_id: 2
}
@data = @cxf_user.change_order_status(1, data)



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

def change_order_status(order_id, data)
  @client.raw('put', "/ecommerce/orders/#{order_id}/status", nil, data_transform(data))
end

#create_child_order(order_id, data) ⇒ Object

Create child order.

Create a child order from a parent order.

Parameters

order_id

(Integer) – Parent order id.

data

(Hash) – Data to be submitted.

Example

data = {
  order_status_id: 2
}
@data = @cxf_user.create_child_order(1, data)



202
203
204
 
# File 'lib/user/ecommerce/orders.rb', line 202

def create_child_order(order_id, data)
  @client.raw('post', "/ecommerce/orders/#{order_id}/child-order", nil, data_transform(data))
end

#create_order(data) ⇒ Object

Create item code.

Create a item code with data.

Parameters

data

(Hash) – Data to be submitted.

Example

data = {
  code_list: [
    { id: 1 },
    { id: 2 }
  ],
  code_list_id: 1,
  title: 'New Item Price'
}
@data = @cxf_user.create_order(data)



57
58
59
60
 
# File 'lib/user/ecommerce/orders.rb', line 57

def create_order(data)
  # FIXME: Api send sku_id as null and DB doesnt allow that.
  @client.raw('post', '/ecommerce/orders', nil, data_transform(data))
end

#delete_order(id) ⇒ Object

Delete item code.

Delete a item code.

Parameters

id

(Integer) – Item code id.

Example

@data = @cxf_user.delete_order(803)



86
87
88
 
# File 'lib/user/ecommerce/orders.rb', line 86

def delete_order(id)
  @client.raw('delete', "/ecommerce/orders/#{id}")
end

#delete_order_line_item(order_id) ⇒ Object

Delete order line item.

Delete a line item from an order.

Parameters

order_id

(Integer) – Order id.

Example

@data = @cxf_user.delete_order_line_item(1)



116
117
118
 
# File 'lib/user/ecommerce/orders.rb', line 116

def delete_order_line_item(order_id)
  @client.raw('delete', "/ecommerce/orders/#{order_id}/line-item")
end

#get_order(id, options = nil) ⇒ Object

Get item code.

Get a item code info.

Parameters

id

(Integer) – Item code id.

options

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

First Example

@data = @cxf_user.get_order(1)

Second Example

options = { fields: 'code_cents' }
@data = @cxf_user.get_order(1, options)



37
38
39
 
# File 'lib/user/ecommerce/orders.rb', line 37

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

#get_orders(options = nil) ⇒ Object

Get item codes.

Get a collection of item codes.

Parameters

options

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

First Example

@data = @cxf_user.get_orders

Second Example

options = { fields: 'code_cents' }
@data = @cxf_user.get_orders(options)



20
21
22
 
# File 'lib/user/ecommerce/orders.rb', line 20

def get_orders(options = nil)
  @client.raw('get', '/ecommerce/orders', options)
end

#reorder_order_line_item(order_id, data) ⇒ Object

Reorder order line items.

Reorder order line items.

Parameters

order_id

(Integer) – Order id.

data

(Hash) – Data to be submitted.

Example

data = {
  line_items: [
    { id: 1, position: 1 },
    { id: 2, position: 2 }
  ]
}
@data = @cxf_user.reorder_order_line_item(1, data)



170
171
172
 
# File 'lib/user/ecommerce/orders.rb', line 170

def reorder_order_line_item(order_id, data)
  @client.raw('put', "/ecommerce/orders/#{order_id}/reorder-line-items", nil, data_transform(data))
end

#update_order(id, data) ⇒ Object

Update item code.

Update a item code info.

Parameters

id

(Integer) – Order item code id.

data

(Hash) – Data to be submitted.

Example

data = {
  code: 12345
}
@data = @cxf_user.update_order(1, data)



74
75
76
 
# File 'lib/user/ecommerce/orders.rb', line 74

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

#update_order_line_item(order_id, data) ⇒ Object

Update order line item.

Update a specific line item within an order.

Parameters

order_id

(Integer) – Order id.

data

(Hash) – Data to be submitted.

Example

data = {
  item_id: 123,
  quantity: 2,
  price: 1000
}
@data = @cxf_user.update_order_line_item(1, data)



134
135
136
 
# File 'lib/user/ecommerce/orders.rb', line 134

def update_order_line_item(order_id, data)
  @client.raw('put', "/ecommerce/orders/#{order_id}/line-item", nil, data_transform(data))
end

#update_order_unit_line_item(order_id, data) ⇒ Object

Update order unit line item.

Update a specific unit line item within an order.

Parameters

order_id

(Integer) – Order id.

data

(Hash) – Data to be submitted.

Example

data = {
  unit_id: 3,
  quantity: 5
}
@data = @cxf_user.update_order_unit_line_item(1, data)



151
152
153
 
# File 'lib/user/ecommerce/orders.rb', line 151

def update_order_unit_line_item(order_id, data)
  @client.raw('put', "/ecommerce/orders/#{order_id}/unit-line-item", nil, data_transform(data))
end