class BigcommerceAPI::ShippingAddress

Attributes

base_cost[RW]
base_handling_cost[RW]
city[RW]
company[RW]
cost_ex_tax[RW]
cost_inc_tax[RW]
cost_tax[RW]
cost_tax_class_id[RW]
country[RW]
country_iso2[RW]
email[RW]
first_name[RW]
handling_cost_ex_tax[RW]
handling_cost_inc_tax[RW]
handling_cost_tax[RW]
handling_cost_tax_class_id[RW]
id[RW]
items_shipped[RW]
items_total[RW]
last_name[RW]
order_id[RW]
phone[RW]
shipping_method[RW]
shipping_zone_id[RW]
shipping_zone_name[RW]
state[RW]
street_1[RW]
street_2[RW]
zip[RW]

Public Class Methods

all(order_id, params={}) click to toggle source
# File lib/bigcommerce_api/shipping_address.rb, line 62
  def all(order_id,
  params={})
  resources = BigcommerceAPI::Base.get("/orders/#{order_id}/shipping_addresses", query: date_adjust(params))
  (resources.success? and !resources.nil?) ? resources.collect{|r| self.new(r)} : []
end
find(order_id, id) click to toggle source
# File lib/bigcommerce_api/shipping_address.rb, line 68
def find(order_id,
  id)
  r = BigcommerceAPI::Base.get("/orders/#{order_id}/shipping_addresses/#{id}")
  (r.success? and !r.nil?) ? self.new(r) : nil
end

Public Instance Methods

create(params={}) click to toggle source
# File lib/bigcommerce_api/shipping_address.rb, line 51
def create(params={})
    self.errors = ["Shipping Addresses are readonly"]
    return false
end
find_for_reload() click to toggle source
# File lib/bigcommerce_api/shipping_address.rb, line 56
def find_for_reload
  self.class.find(self.order_id,
    self.id)
end
parent() click to toggle source
# File lib/bigcommerce_api/shipping_address.rb, line 41
def parent
  'order'
end
resource_url() click to toggle source

this overrides the default method, since this has to come in with an order id

# File lib/bigcommerce_api/shipping_address.rb, line 37
def resource_url
  "orders/#{self.order_id}/shipping_addresses"
end
save() click to toggle source

TODO: these can probably go in a ReadOnly class

# File lib/bigcommerce_api/shipping_address.rb, line 46
def save
    self.errors = ["Shipping Addresses are readonly"]
    return false
end