Class: ShiprocketAPI::ReturnOrder

Inherits:
Base
  • Object
show all
Includes:
Shared::OrderHelper
Defined in:
lib/shiprocket_api/resources/return_order.rb

Constant Summary collapse

DEFAULT_ATTRS = 
{
  order_id: '',
  order_date: '',
  channel_id: '',
  pickup_customer_name: '',
  pickup_last_name: '',
  pickup_address: '',
  pickup_address_2: '',
  pickup_city: '',
  pickup_state: '',
  pickup_country: '',
  pickup_pincode: '',
  pickup_email: '',
  pickup_phone: '',
  pickup_isd_code: '',
  pickup_location_id: '',
  shipping_customer_name: '',
  shipping_last_name: '',
  shipping_address: '',
  shipping_address_2: '',
  shipping_city: '',
  shipping_country: '',
  shipping_pincode: '',
  shipping_state: '',
  shipping_email: '',
  shipping_isd_code: '',
  shipping_phone: '',
  order_items: [
    ShiprocketAPI::OrderItem.new
  ],
  payment_method: 'Prepaid',
  sub_total: '',
  length: '',
  breadth: '',
  height: '',
  weight: ''
}

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Shared::OrderHelper

#create_pickup, #generate_label

Methods inherited from Base

clear_session, create_session, #initialize, set_prefix, temp_session

Constructor Details

This class inherits a constructor from ShiprocketAPI::Base

Class Method Details

.find_every(options) ⇒ Object 



55
56
57
58
59
 
# File 'lib/shiprocket_api/resources/return_order.rb', line 55

def find_every(options)
  set_prefix_to_list_all do
    super
  end
end

.set_prefix_to_list_all(&block) ⇒ Object 



51
52
53
 
# File 'lib/shiprocket_api/resources/return_order.rb', line 51

def set_prefix_to_list_all(&block)
  set_prefix("#{Base.prefix}/orders/processing/return", &block)
end

Instance Method Details

#generate_awb(courier_id:) ⇒ Object 



62
63
64
65
66
67
68
69
70
71
 
# File 'lib/shiprocket_api/resources/return_order.rb', line 62

def generate_awb(courier_id:)
  return false unless attributes['shipment_id'] && shipment_id != 0

  self.awb = ::ShiprocketAPI::Awb.new(
    shipment_id: shipment_id,
    courier_id: courier_id,
    is_return: 1
  )
  awb.save
end