Class: Workarea::GlobalE::Merchant::InternationalDetails

Inherits:
Object
  • Object
show all
Defined in:
app/services/workarea/global_e/merchant/international_details.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(hash) ⇒ InternationalDetails

Returns a new instance of InternationalDetails.



7
8
9
 
# File 'app/services/workarea/global_e/merchant/international_details.rb', line 7

def initialize(hash)
  @hash = hash
end

Instance Attribute Details

#hash ⇒ Object (readonly)

Returns the value of attribute hash.



5
6
7
 
# File 'app/services/workarea/global_e/merchant/international_details.rb', line 5

def hash
  @hash
end

Instance Method Details

#card_number_last_four_digits ⇒ String

The last 4 digits of Card number (if applicable).

Returns:

  • (String) 


265
266
267
 
# File 'app/services/workarea/global_e/merchant/international_details.rb', line 265

def card_number_last_four_digits
  hash["CardNumberLastFourDigits"]
end

#cash_on_delivery_fee_customer_currency ⇒ Float

Additional charge paid by the end customer when “Cash on Delivery” payment method has been selected.

Returns:

  • (Float) 


282
283
284
 
# File 'app/services/workarea/global_e/merchant/international_details.rb', line 282

def cash_on_delivery_fee_customer_currency
  hash["CashOnDeliveryFee"]
end

#consignment_fee ⇒ Float

Consignment fee paid by the end customer in the currency denoted by CurrencyCode. This value is included in TotalShippingPrice.

Returns:

  • (Float) 


61
62
63
 
# File 'app/services/workarea/global_e/merchant/international_details.rb', line 61

def consignment_fee
  hash["ConsignmentFee"]
end

#currency_code ⇒ String

3-char ISO code for the currency selected by the end customer for the order payment.

Returns:

  • (String) 


16
17
18
 
# File 'app/services/workarea/global_e/merchant/international_details.rb', line 16

def currency_code
  hash["CurrencyCode"]
end

#delivery_days_from ⇒ Integer

Minimum number of days for delivery to the end customer for the selected shipping method.

Returns:

  • (Integer) 


155
156
157
 
# File 'app/services/workarea/global_e/merchant/international_details.rb', line 155

def delivery_days_from
  hash["DeliveryDaysFrom"]
end

#delivery_days_to ⇒ Integer

Maximum number of days for delivery to the end customer for the selected shipping method.

Returns:

  • (Integer) 


164
165
166
 
# File 'app/services/workarea/global_e/merchant/international_details.rb', line 164

def delivery_days_to
  hash["DeliveryDaysTo"]
end

#discounted_shipping_price ⇒ Float

The price paid by customer in local currency. Total Shipping price reducing Order Discounts International price.

Returns:

  • (Float) 


247
248
249
 
# File 'app/services/workarea/global_e/merchant/international_details.rb', line 247

def discounted_shipping_price
  hash["DiscountedShippingPrice"]
end

#duties_guaranteed ⇒ Boolean

Indicates if the end customer has selected the “guaranteed duties and taxes” option.

Returns:

  • (Boolean) 


192
193
194
 
# File 'app/services/workarea/global_e/merchant/international_details.rb', line 192

def duties_guaranteed
  hash["DutiesGuaranteed"]
end

#expiration_date ⇒ String

Card expiration date in YYYY-MM-DD format (if applicable).

Returns:

  • (String) 


273
274
275
 
# File 'app/services/workarea/global_e/merchant/international_details.rb', line 273

def expiration_date
  hash["ExpirationDate"]
end

#order_tracking_number ⇒ String

Tracking number used by the selected international shipping method for this order.

Returns:

  • (String) 


201
202
203
 
# File 'app/services/workarea/global_e/merchant/international_details.rb', line 201

def order_tracking_number
  hash["OrderTrackingNumber"]
end

#order_tracking_url ⇒ String

Full tracking URL including OrderTrackingNumber used by the selected international shipping method for this order.

Returns:

  • (String) 


210
211
212
 
# File 'app/services/workarea/global_e/merchant/international_details.rb', line 210

def order_tracking_url
  hash["OrderTrackingUrl"]
end

#order_waybill_number ⇒ String

Waybill number used by the selected international shipping method for this order.

Returns:

  • (String) 


219
220
221
 
# File 'app/services/workarea/global_e/merchant/international_details.rb', line 219

def order_waybill_number
  hash["OrderWaybillNumber"]
end

#parcels_tracking ⇒ Array<Workarea::GlobalE::Merchant::ParcelTracking>

List of Merchant.ParcelTracking objects, each object holds parcel tracking number and full tracking URL for the relevant shipper (with the parcel tracking number).

Returns:



257
258
259
 
# File 'app/services/workarea/global_e/merchant/international_details.rb', line 257

def parcels_tracking
  hash["ParcelsTracking"]
end

#payment_method_code ⇒ String

Code denoting the selected payment method as defined on the Merchant’s site (to be mapped on Global-e side). If this payment method doesn’t exist on the Merchant’s site, the internal Global-e payment method code will be specified instead.

Returns:

  • (String) 


175
176
177
 
# File 'app/services/workarea/global_e/merchant/international_details.rb', line 175

def payment_method_code
  hash["PaymentMethodCode"]
end

#payment_method_name ⇒ String

Name of the selected payment method.

Returns:

  • (String) 


183
184
185
 
# File 'app/services/workarea/global_e/merchant/international_details.rb', line 183

def payment_method_name
  hash["PaymentMethodName"]
end

#remote_area_surcharge ⇒ Float

Remote area surcharge paid by the end customer in the currency denoted by CurrencyCode. This value is included in TotalShippingPrice.

Returns:

  • (Float) 


79
80
81
 
# File 'app/services/workarea/global_e/merchant/international_details.rb', line 79

def remote_area_surcharge
  hash["RemoteAreaSurcharge"]
end

#same_day_dispatch_cost ⇒ Float

Cost of “Same Day Dispatch” option (if selected by the end customer on Global-e checkout), in the currency denoted by CurrencyCode. This value is NOT included in TotalShippingPrice.

Returns:

  • (Float) 


89
90
91
 
# File 'app/services/workarea/global_e/merchant/international_details.rb', line 89

def same_day_dispatch_cost
  hash["SameDayDispatchCost"]
end

#shipping_method_code ⇒ String

Code denoting the selected international shipping method as defined on the Merchant’s site (to be mapped on Global-e side). If this international shipping method doesn’t exist on the Merchant’s site, the internal Global-e shipping method code will be specified instead.

Returns:

  • (String) 


118
119
120
 
# File 'app/services/workarea/global_e/merchant/international_details.rb', line 118

def shipping_method_code
  hash["ShippingMethodCode"]
end

#shipping_method_name ⇒ String

Name of the selected international shipping method.

Returns:

  • (String) 


126
127
128
 
# File 'app/services/workarea/global_e/merchant/international_details.rb', line 126

def shipping_method_name
  hash["ShippingMethodName"]
end

#shipping_method_status_code ⇒ String

Code denoting the selected shipping status as defined on the Merchant’s site (to be mapped on Global- e side). If this shipping status doesn’t exist on the Merchant’s site, the internal Global-e shipping status code will be specified instead.

Returns:

  • (String) 


230
231
232
 
# File 'app/services/workarea/global_e/merchant/international_details.rb', line 230

def shipping_method_status_code
  hash["ShippingMethodStatusCode"]
end

#shipping_method_status_name ⇒ Object

Name of the shipping status.

@return [String]



238
239
240
 
# File 'app/services/workarea/global_e/merchant/international_details.rb', line 238

def shipping_method_status_name
  hash["ShippingMethodStatusName"]
end

#shipping_method_type_code ⇒ String

Code denoting the selected international shipping method type as defined on the Merchant’s site (to be mapped on Global-e side). If this international shipping method type doesn’t exist on the Merchant’s site, the internal Global-e shipping method type code will be specified instead.

Returns:

  • (String) 


138
139
140
 
# File 'app/services/workarea/global_e/merchant/international_details.rb', line 138

def shipping_method_type_code
  hash["ShippingMethodTypeCode"]
end

#shipping_method_type_name ⇒ String

Name of the selected international shipping method type.

Returns:

  • (String) 


146
147
148
 
# File 'app/services/workarea/global_e/merchant/international_details.rb', line 146

def shipping_method_type_name
  hash["ShippingMethodTypeName"]
end

#size_overchange_value ⇒ Float

Oversized items charge paid by the end customer in the currency denoted by CurrencyCode. This value is included in TotalShippingPrice.

Returns:

  • (Float) 


70
71
72
 
# File 'app/services/workarea/global_e/merchant/international_details.rb', line 70

def size_overchange_value
  hash["SizeOverchargeValue"]
end

#total_ccf_price ⇒ Float

Total Customs Clearance Fees value in the currency denoted by CurrencyCode. This value is included in TotalDutiesPrice.

Returns:

  • (Float) 


107
108
109
 
# File 'app/services/workarea/global_e/merchant/international_details.rb', line 107

def total_ccf_price
  hash["TotalCCFPrice"]
end

#total_duties_price ⇒ Float

Total Duties & Taxes value including Customs Clearance Fees, in the currency denoted by CurrencyCode.

Returns:

  • (Float) 


98
99
100
 
# File 'app/services/workarea/global_e/merchant/international_details.rb', line 98

def total_duties_price
  hash["TotalDutiesPrice"]
end

#total_price ⇒ Float

Total order price in the currency denoted by CurrencyCode.

Returns:

  • (Float) 


24
25
26
 
# File 'app/services/workarea/global_e/merchant/international_details.rb', line 24

def total_price
  hash["TotalPrice"]
end

#total_shipping_price ⇒ Float

Total shipping price in the currency denoted by CurrencyCode.

Returns:

  • (Float) 


52
53
54
 
# File 'app/services/workarea/global_e/merchant/international_details.rb', line 52

def total_shipping_price
  hash["TotalShippingPrice"]
end

#total_vat_amount ⇒ Float

Amount of VAT paid by the customer to Global-e

Returns:

  • (Float) 


290
291
292
 
# File 'app/services/workarea/global_e/merchant/international_details.rb', line 290

def total_vat_amount
  hash["TotalDutiesPrice"]
end

#transaction_currency_code ⇒ String

3-char ISO code for the currency actually used for the current order payment. TransactionCurrencyCode may differ from CurrencyCode if the currency selected by the end customer could not be used with the selected payment method.

Returns:

  • (String) 


35
36
37
 
# File 'app/services/workarea/global_e/merchant/international_details.rb', line 35

def transaction_currency_code
  hash["TransactionCurrencyCode"]
end

#transaction_total_price ⇒ Float

Total order price actually paid by the end customer in the currency denoted by TransactionCurrencyCode.

Returns:

  • (Float) 


44
45
46
 
# File 'app/services/workarea/global_e/merchant/international_details.rb', line 44

def transaction_total_price
  hash["TransactionTotalPrice"]
end