Class: Edi::AmazonVc::OrderMessageProcessor

Inherits:
BaseEdiService show all
Defined in:
app/services/edi/amazon_vc/order_message_processor.rb

Defined Under Namespace

Classes: BatchProcessResult, LineCreationResult, Result

Constant Summary

Constants included from Edi::AddressAbbreviator

Edi::AddressAbbreviator::MAX_LENGTH

Instance Attribute Summary

Attributes inherited from BaseEdiService

#orchestrator

Instance Method Summary collapse

Methods inherited from BaseEdiService

#duplicate_po_already_notified?, #initialize, #mark_duplicate_po_as_notified, #report_order_creation_issues, #safe_process_edi_communication_log

Methods included from Edi::AddressAbbreviator

#abbreviate_street, #collect_street_originals, #record_address_abbreviation_notes

Methods inherited from BaseService

#initialize, #log_debug, #log_error, #log_info, #log_warning, #logger, #options, #tagged_logger

Constructor Details

This class inherits a constructor from Edi::BaseEdiService

Instance Method Details

#apply_payment(order, order_hash) ⇒ Object 



232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'app/services/edi/amazon_vc/order_message_processor.rb', line 232

def apply_payment(order, order_hash)
  order.reload
  order.pending_payment!
  total_due = order.total
  order.payments.build.tap do |payment|
    payment.category = Payment::PO
    payment.currency = order.currency
    payment.amount = total_due
    payment.state = 'authorized'
    payment.po_number = order_hash[:purchaseOrderNumber]
    payment.delivery = order.deliveries.quoting.first
    payment.save!
  end
end

#create_line_items(order, order_hash) ⇒ Object 



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'app/services/edi/amazon_vc/order_message_processor.rb', line 276

def create_line_items(order, order_hash)
  #        "orderDetails" => {...
  #                   "items" => [
  #         [0] {
  #                  "itemSequenceNumber" => 1,
  #              "buyerProductIdentifier" => "B005D7OBB4",
  #             "vendorProductIdentifier" => "TW-F10BS-PL",
  #                               "title" => "WarmlyYours 10-Bar Infinity Towel Warmer, Plug-in, Stainless Steel",
  #                     "orderedQuantity" => {
  #                        "amount" => 1,
  #                 "unitOfMeasure" => "Each"
  #             },
  #                         "giftDetails" => {
  #                 "giftMessage" => "Hi,\\nEnjoy your gift!\\nFrom Leslie Haley"
  #             },
  #                            "netPrice" => {
  #                 "currencyCode" => "USD",
  #                       "amount" => "209.3"
  #             },
  #                          "taxDetails" => {
  #                 "taxLineItem" => [
  #                     [0] {
  #                           "taxRate" => "0.062491",
  #                         "taxAmount" => {
  #                             "currencyCode" => "USD",
  #                                   "amount" => "13.31"
  #                         }
  #                     }
  #                 ]
  #             },
  #                          "totalPrice" => {
  #                 "currencyCode" => "USD",
  #                       "amount" => "212.99"
  #             }
  #         }
  #     ]
  # }

  line_total = BigDecimal(0)
  cust = order.customer
  all_skus_valid = true
  errors = []
  bad_vendor_skus = []
  bad_merchant_skus = []
  catalog_items = cust.catalog.catalog_items.where(state: %w[active active_hidden require_vendor_update pending_vendor_update pending_discontinue]).order(state: :asc)
  order_hash.dig(:orderDetails, :items).each_with_index do |line_hash, i|
    # First we try by vendor product identifier
    vendor_sku = line_hash[:vendorProductIdentifier]
    # then we try by buyer product identifier
    buyer_asin = line_hash[:buyerProductIdentifier]
    raise 'Missing identifiers vendorProductIdentifier and buyerProductIdentifier in order query' if vendor_sku.blank? && buyer_asin.blank?

    matched_catalog_item = nil
    matched_catalog_item ||= catalog_items.by_skus(vendor_sku).first if vendor_sku.present?
    matched_catalog_item ||= catalog_items.by_asins(buyer_asin).first if buyer_asin.present?
    if matched_catalog_item
      order.line_items.build.tap do |line_item|
        line_item.quantity = line_hash.dig(:orderedQuantity, :amount).to_i # 2
        line_item.edi_reference = "#{order_hash[:purchaseOrderNumber]}-#{i + 1}"
        line_item.edi_line_number = line_hash[:itemSequenceNumber]
        line_item.catalog_item = matched_catalog_item
        price = BigDecimal(line_hash.dig(:netPrice, :amount).to_s)
        line_item.edi_unit_cost = price
        line_total += price * line_item.quantity
      end
      if matched_catalog_item.state_requires_edi_warning_on_order?
        subj = "EDI order for orchestrator: #{orchestrator.partner}, processed, but catalog item with SKU #{matched_catalog_item.sku} in state #{matched_catalog_item.state} (i.e. not active state)"
        msg = "EDI order for orchestrator: #{orchestrator.partner}, catalog item with SKU #{matched_catalog_item.sku} in state #{matched_catalog_item.state} (i.e. not active state). The order #{order.reference_number} has been processed but this is an indication of a possible issue with this catalog item."
        InternalMailer.notify_edi_admin_of_warning(subj, msg).deliver_later
      end
    else
      all_skus_valid = false
      bad_vendor_skus << vendor_sku.presence
      bad_merchant_skus << buyer_asin.presence
      errors << "Unknown vendor sku: #{vendor_sku} / merchant sku: #{buyer_asin}"
    end
  end
  order.save!
  LineCreationResult.new(line_total: line_total, lines_created: order.line_items.size, all_skus_valid: all_skus_valid,
                         error_message: "#{errors.to_sentence.capitalize}. Please fix the order message or catalog items, otherwise you will need to send a 'reject' acknowledgement with reason 'bad SKU'.", bad_vendor_skus: bad_vendor_skus.compact, bad_merchant_skus: bad_merchant_skus.compact)
end

#create_shipping_address(order_hash) ⇒ Object 



358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'app/services/edi/amazon_vc/order_message_processor.rb', line 358

def create_shipping_address(order_hash)
  #        "orderDetails" => {...
  #             "shipToParty" => {
  #                  "name" => "Leslie Haley",
  #          "addressLine1" => "45R HANOVER ST",
  #          "addressLine2" => "",
  #          "addressLine3" => "",
  #                  "city" => "NEWBURY",
  #                "county" => "MA",
  #         "stateOrRegion" => "MA",
  #            "postalCode" => "01951-1129",
  #           "countryCode" => "US",
  #                 "phone" => "978-804-6761"
  #     }...

  raw_street1 = order_hash.dig(:orderDetails, :shipToParty, :addressLine1)
  raw_street2 = order_hash.dig(:orderDetails, :shipToParty, :addressLine2)
  originals = collect_street_originals(street1: raw_street1, street2: raw_street2)

  address = Address.new
  address.person_name_override = order_hash.dig(:orderDetails, :shipToParty, :name).to_s.titleize.strip
  address.street1 = abbreviate_street(raw_street1)
  address.street2 = abbreviate_street(raw_street2)
  address.city = order_hash.dig(:orderDetails, :shipToParty, :city)
  address.state_code = order_hash.dig(:orderDetails, :shipToParty, :stateOrRegion)
  address.country_iso = order_hash.dig(:orderDetails, :shipToParty, :countryCode)
  address.zip = order_hash.dig(:orderDetails, :shipToParty, :postalCode).to_s.upcase.delete(' ').strip
  address.disable_address_correction = true
  address.override_all_address_validation = true
  address.save!
  [address, originals]
end

#customer(segment = nil) ⇒ Object 



15
16
17
 
# File 'app/services/edi/amazon_vc/order_message_processor.rb', line 15

def customer(segment = nil)
  orchestrator.customer(segment)
end

#match_shipping_code(shipping_code) ⇒ Object

Returns the shipping option name and special service to use like saturday delivery



392
393
394
 
# File 'app/services/edi/amazon_vc/order_message_processor.rb', line 392

def match_shipping_code(shipping_code)
  orchestrator.ship_code_mapper.az_to_hw(shipping_code)
end

#process(edi_logs = nil, edi_transaction_id: nil) ⇒ Object

Picks up the edi communication log in the queue ready to process, generate acknowledgements



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'app/services/edi/amazon_vc/order_message_processor.rb', line 20

def process(edi_logs = nil, edi_transaction_id: nil)
  edi_logs ||= EdiCommunicationLog.requiring_processing.where(partner: orchestrator.partner, category: 'order_batch')
  edi_logs = [edi_logs].flatten # This way you can pass a single edi communication log
  # Wrap in one big transaction
  batch_process_results = []
  edi_logs.each do |edi_log|
    log_info "Starting processing edi communication log #{edi_log.id}"
    EdiCommunicationLog.transaction do
      # Process the orders in the batch
      batch_process_result = process_orders(edi_log.data, edi_transaction_id: edi_transaction_id, edi_log_id: edi_log.id)
      # Record some meta data in file info
      edi_log.file_info ||= {}
      edi_log.file_info[:orders_in_batch] = batch_process_result.orders_in_batch
      batch_process_results << batch_process_result
      edi_log.complete!
      # Mark our edi log as processed, we need some error handling at one point
      # Associate the created orders
      batch_process_result.orders_created.each do |order|
        edi_log.edi_documents.create(order: order)
      end
    rescue StandardError => e
      edi_log.notes = "#{e} at #{e&.backtrace_locations}"
      edi_log.error
      ErrorReporting.error(e, edi_communication_log_id: edi_log.id)
      # End begin rescue block
    end # End transaction
  end # End edi log iteration
  orders_created = batch_process_results.flat_map(&:orders_created)
  if (orders_to_report = orders_created.to_a.select(&:requires_intervention?)).present?
    InternalMailer.edi_orders_notification(orders_to_report).deliver_later
  end

  Result.new(batch_process_results: batch_process_results)
end

#process_order(order_hash = nil) ⇒ Object

Process a single order



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'app/services/edi/amazon_vc/order_message_processor.rb', line 84

def process_order(order_hash = nil)
  # "purchaseOrderNumber" => "Ts0HdQtXs",
  #        "orderDetails" => {
  #     "customerOrderNumber" => "111-8132329-7723404",
  #               "orderDate" => "2020-12-08T10:03:38Z",
  #             "orderStatus" => "NEW",
  #         "shipmentDetails" => {
  #                  "isPriorityShipment" => true,
  #         "isScheduledDeliveryShipment" => false,
  #                     "isPslipRequired" => true,
  #                              "isGift" => true,
  #                          "shipMethod" => "UPS_GR_RES",
  #                       "shipmentDates" => {
  #                 "requiredShipDate" => "2020-12-08T22:00:00Z",
  #             "promisedDeliveryDate" => "2020-12-17T07:59:59Z"
  #         }
  #     },
  #                "taxTotal" => {
  #         "taxLineItem" => [
  #             [0] {
  #                 "taxAmount" => {
  #                     "currencyCode" => "USD",
  #                           "amount" => "13.31"
  #                 }
  #             }
  #         ]
  #     },
  #            "sellingParty" => {
  #         "partyId" => "WAX7V"
  #     },
  #           "shipFromParty" => {
  #         "partyId" => "DFEE"
  #     },
  #             "shipToParty" => {
  #                  "name" => "Leslie Haley",
  #          "addressLine1" => "45R HANOVER ST",
  #          "addressLine2" => "",
  #          "addressLine3" => "",
  #                  "city" => "NEWBURY",
  #                "county" => "MA",
  #         "stateOrRegion" => "MA",
  #            "postalCode" => "01951-1129",
  #           "countryCode" => "US",
  #                 "phone" => "978-804-6761"
  #     },
  #             "billToParty" => {
  #         "partyId" => "ASI"
  #     },
  #                   "items" => [
  #         [0] {
  #                  "itemSequenceNumber" => 1,
  #              "buyerProductIdentifier" => "B005D7OBB4",
  #             "vendorProductIdentifier" => "TW-F10BS-PL",
  #                               "title" => "WarmlyYours 10-Bar Infinity Towel Warmer, Plug-in, Stainless Steel",
  #                     "orderedQuantity" => {
  #                        "amount" => 1,
  #                 "unitOfMeasure" => "Each"
  #             },
  #                         "giftDetails" => {
  #                 "giftMessage" => "Hi,\\nEnjoy your gift!\\nFrom Leslie Haley"
  #             },
  #                            "netPrice" => {
  #                 "currencyCode" => "USD",
  #                       "amount" => "209.3"
  #             },
  #                          "taxDetails" => {
  #                 "taxLineItem" => [
  #                     [0] {
  #                           "taxRate" => "0.062491",
  #                         "taxAmount" => {
  #                             "currencyCode" => "USD",
  #                                   "amount" => "13.31"
  #                         }
  #                     }
  #                 ]
  #             },
  #                          "totalPrice" => {
  #                 "currencyCode" => "USD",
  #                       "amount" => "212.99"
  #             }
  #         }
  #     ]
  # }
  # }
  cust = customer
  order = cust.orders.build
  order.edi_original_order_message = order_hash.to_json
  order.edi_orchestrator_partner = orchestrator.partner.to_s
  order.edi_order_date = Time.zone.parse(order_hash.dig(:orderDetails, :orderDate)).to_date # Parse "2020-11-03 17:32:10.000000 +00:00" to date
  order.edi_transaction_id = "#{order.edi_order_date}-#{order_hash[:purchaseOrderNumber]}"
  order.edi_po_number = order_hash[:purchaseOrderNumber]
  address, address_originals = create_shipping_address(order_hash)
  order.shipping_address = address
  order.shipping_phone = order_hash.dig(:orderDetails, :shipToParty, :phone)
  recipient_name = order.shipping_address.person_name_override || order.shipping_address.company_name_override
  order.customer_reference = "Purchase Order Number: #{order_hash[:purchaseOrderNumber]}, Customer Order Number: #{order_hash.dig(:orderDetails, :customerOrderNumber)}"
  # original currency
  order.currency = cust.store.currency
  order.attention_name_override = recipient_name
  order.edi_shipping_option_name = set_shipping_option(order, order_hash)
  order.single_origin = true
  order.edi_is_pick_slip_required = order_hash.dig(:orderDetails, :shipmentDetails, :isPslipRequired).nil? ? cust.customer_record&.always_custom_packing_list? : order_hash.dig(:orderDetails, :shipmentDetails, :isPslipRequired).nil?
  order.save!
  record_address_abbreviation_notes(order, address_originals, order.shipping_address)
  line_creation_result = create_line_items(order, order_hash)
  raise line_creation_result.error_message unless line_creation_result.all_skus_valid

  apply_payment(order, order_hash)

  # Revenue before taxes (for price comparison), if price differs, problem, cr hold
  if orchestrator.test_mode?
    order.price_match = order.line_total
  else
    order.line_total
    line_creation_result.line_total
    order.price_match = line_creation_result.line_total # will get save when we call the event
  end
  order.state = 'in_cr_hold' # Set this as the default state
  order.recalculate_shipping = true
  order.save!
  order.reset_discount # temporary measure to force sanity and have revenue show on the order
  order.save!
  if (same_po_orders = Order.where(edi_po_number: order.edi_po_number).where.not(id: order.id)).any?
    # warn but don't release orders for every duplicate PO, let someone do it manually
    subj = "EDI order message for orchestrator: #{orchestrator.partner}, order #{order.reference_number} CREATED, order message PO: #{order.edi_po_number}, duplicate"
    msg = "EDI order for orchestrator: #{orchestrator.partner}, order #{order.reference_number}, has the same PO #{order.edi_po_number} as the following older EDI orders: #{same_po_orders.map do |o|
      "#{o.reference_number} (created #{o.created_at.to_date})"
    end.join(', ')}. It has been processed but this is an indication of a possible duplicate order or other issue."
    InternalMailer.notify_edi_admin_of_warning(subj, msg).deliver_later
  else
    order.reload.release_order # Then try to release, if there's any issue (discrepancy, etc) the order will remain on hold
  end

  # simplest thing to do is to flag the issue and raise an exception, don't even create the order

  order
end

#process_orders(orders_data, edi_transaction_id: nil, edi_log_id: nil) ⇒ Object

Iterates through the batch order data



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'app/services/edi/amazon_vc/order_message_processor.rb', line 56

def process_orders(orders_data, edi_transaction_id: nil, edi_log_id: nil)
  json_hash = JSON.parse(orders_data).with_indifferent_access
  orders_created = []
  orders_in_batch = 0
  (json_hash.dig(:payload, :orders) || []).each do |order_hash|
    log_info "Processing order #{order_hash.inspect}"
    orders_in_batch += 1
    po_number = order_hash[:purchaseOrderNumber]
    if customer.orders.where('created_at > ?', 12.months.ago).where(edi_po_number: po_number).count.zero? # only process these once, allow for duplicate EDI PO numbers (it has happened), as long as it has been at least 12 months old. We want to eliminate duplicate orders with the same PO, from message to message i.e. within ~the same day
      orders_created << process_order(order_hash)
    elsif (same_po_orders = Order.where('created_at < ?', 4.days.ago).where('created_at > ?', 12.months.ago).where(edi_po_number: po_number)).any? # otherwise warn that we skipped creating order because we found a matching PO order created older than four days ago, which might indicate the small chance of an order PO collision from another EDI partner
      # Only send notification if we haven't already notified about this duplicate PO
      unless duplicate_po_already_notified?(po_number, edi_log_id)
        subj = "EDI order message for orchestrator: #{orchestrator.partner}, SKIPPED, order message PO: #{po_number}, duplicate"
        msg = "EDI order message for orchestrator: #{orchestrator.partner}, EDI Communication log ID: #{edi_log_id}, order message PO: #{po_number}, has the same PO as the following recent EDI orders: #{same_po_orders.map do |o|
          "#{o.reference_number} (created #{o.created_at.to_date})"
        end.join(', ')}. It has been NOT been processed but SKIPPED as this is an indication of a duplicate order. Please ensure there is no PO number from another partner that might inadvertently match."
        InternalMailer.notify_edi_admin_of_warning(subj, msg).deliver_later
        mark_duplicate_po_as_notified(po_number, edi_log_id)
      end
    end
  end
  BatchProcessResult.new(batch_number: nil,
                         orders_created: orders_created,
                         orders_in_batch: orders_in_batch)
end

#set_shipping_option(order, order_hash) ⇒ Object 



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'app/services/edi/amazon_vc/order_message_processor.rb', line 247

def set_shipping_option(order, order_hash)
  #        "orderDetails" => { ...
  #         "shipmentDetails" => {
  #                  "isPriorityShipment" => true,
  #         "isScheduledDeliveryShipment" => false,
  #                     "isPslipRequired" => true,
  #                              "isGift" => true,
  #                          "shipMethod" => "UPS_GR_RES",
  #                       "shipmentDates" => {
  #                 "requiredShipDate" => "2020-12-08T22:00:00Z",
  #             "promisedDeliveryDate" => "2020-12-17T07:59:59Z"
  #         }...

  shipping_code = order_hash.dig(:orderDetails, :shipmentDetails, :shipMethod)
  shipping_option_result = match_shipping_code(shipping_code)
  order.edi_original_ship_code = "#{shipping_code}"
  order.signature_confirmation = shipping_option_result&.signature
  order.shipping_method = shipping_option_result&.name
  so = ShippingOption.find_by(name: order.shipping_method)
  order.requested_ship_on_or_after = Date.parse(order_hash.dig(:orderDetails, :shipmentDetails, :shipmentDates, :requiredShipDate)) if order_hash.dig(:orderDetails, :shipmentDetails, :shipmentDates, :requiredShipDate).present?
  order.requested_ship_before = (Date.parse(order_hash.dig(:orderDetails, :shipmentDetails, :shipmentDates, :promisedDeliveryDate)) - so.days_commitment.days + 1.day) if order_hash.dig(:orderDetails, :shipmentDetails, :shipmentDates,
                                                                                                                                                                                         :promisedDeliveryDate).present?
  if order.requested_ship_on_or_after && (order.requested_ship_on_or_after > Date.current)
    order.do_not_reserve_stock = false # we want to reserve the stock
    order.future_release_date = order.requested_ship_on_or_after
  end
  order.shipping_method
end

#shipping_invalid?(order) ⇒ Boolean

Returns:

  • (Boolean) 


222
223
224
225
226
227
228
229
230
 
# File 'app/services/edi/amazon_vc/order_message_processor.rb', line 222

def shipping_invalid?(order)
  dq = order.deliveries.quoting.first
  return true unless dq
  return true if dq.shipping_option.is_override?
  return true unless dq.shipping_option.name == order.edi_shipping_option_name
  return true unless dq.signature_confirmation == order.signature_confirmation

  false
end