Class: BigcommerceOrderAgent::Client::Order

Inherits:
AbstractClient show all
Includes:
Carmen
Defined in:
lib/client/order.rb

Instance Method Summary collapse

Methods inherited from AbstractClient

#client, #index, #initialize, #uri, uri_base, #uri_base

Constructor Details

This class inherits a constructor from BigcommerceOrderAgent::Client::AbstractClient

Instance Method Details

#get(id, params = {}) ⇒ Object 



10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/client/order.rb', line 10

def get(id, params = {})
  order = nil

  begin
    response = client.get(uri({ order_id: id }), params)
    order = response.body
  rescue Faraday::Error => e
    raise BigcommerceApiError.new(
      e.response[:status],
      'get order',
      "Failed to get order #{id}",
      id,
      {
        errors: JSON.parse(e.response[:body])['errors']
      },
      e
    )
  end

  if order.present?
    order[:products] = get_products(id)
    order[:coupons] = get_coupons(id)
    order[:shipping_addresses] = get_shipping_addresses(id)
    order[:transactions] = get_transactions(id)
    order[:shipments] = get_shipments(id)

    order['billing_address']['state_code'] = get_region_code(order['billing_address'])

    transactions = get_transactions(id)
  end

  return order
end

#get_coupons(order_id, params = {}) ⇒ Object

Returns order-level promotions



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/client/order.rb', line 113

def get_coupons(order_id, params = {})
  begin
    response = client.get(uri({ order_id: order_id }, 'coupons'), params)
    return response.body
  rescue Faraday::Error => e
    raise BigcommerceApiError.new(
      e.response[:status],
      'get order coupons',
      "Failed to get order coupons #{order_id}",
      order_id,
      {
        errors: JSON.parse(e.response[:body])['errors']
      },
      e
    )
  end
end

#get_products(order_id, params = {}) ⇒ Object

Returns the order’s line items



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/client/order.rb', line 47

def get_products(order_id, params = {})
  begin
    response = client.get(uri({ order_id: order_id }, 'products'), params)
    return response.body
  rescue Faraday::Error => e
    raise BigcommerceApiError.new(
      e.response[:status],
      'get order products',
      "Failed to get order products #{order_id}",
      order_id,
      {
        errors: JSON.parse(e.response[:body])['errors']
      },
      e
    )
  end
end

#get_region_code(address) ⇒ Object

Returns the region (state) code for the provided address



151
152
153
154
155
156
157
158
 
# File 'lib/client/order.rb', line 151

def get_region_code(address)
  country = Country.named(address['country'])
  state = country.subregions.named(address['state'])

  #  For cases where a matching state is not found, default to the `state`
  #  value on the address. (This is not uncommon for international addresses)
  return state.nil? ? address['state'] : state.code
end

#get_shipments(order_id, params = {}) ⇒ Object

Returns order shipments



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/client/order.rb', line 94

def get_shipments(order_id, params = {})
  begin
    response = client.get(uri({ order_id: order_id }, 'shipments'), params)
    return response.body
  rescue Faraday::Error => e
    raise BigcommerceApiError.new(
      e.response[:status],
      'get order shipments',
      "Failed to get order shipments #{order_id}",
      order_id,
      {
        errors: JSON.parse(e.response[:body])['errors']
      },
      e
    )
  end
end

#get_shipping_addresses(order_id, params = {}) ⇒ Object

Returns an array of shipping addresses attached to the order



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/client/order.rb', line 66

def get_shipping_addresses(order_id, params = {})
  begin
    response = client.get(uri({ order_id: order_id }, 'shipping_addresses'), params)

    addresses = response.body

    if (addresses)
      addresses.each do |addr|
        addr['state_code'] = get_region_code(addr)
      end
    end

    return addresses
  rescue Faraday::Error => e
    raise BigcommerceApiError.new(
      e.response[:status],
      'get order shipping address',
      "Failed to get order shipping address #{order_id}",
      order_id,
      {
        errors: JSON.parse(e.response[:body])['errors']
      },
      e
    )
  end
end

#get_transactions(order_id, params = {}) ⇒ Object

Returns order transactions. NOTE:



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/client/order.rb', line 132

def get_transactions(order_id, params = {})
  begin
    response = client.get(uri({ api_version: 'v3', order_id: order_id }, 'transactions'), params)
    return response.body['data']
  rescue Faraday::Error => e
    raise BigcommerceApiError.new(
      e.response[:status],
      'get order transactions',
      "Failed to get order transactions #{order_id}",
      order_id,
      {
        errors: JSON.parse(e.response[:body])['errors']
      },
      e
    )
  end
end