Class: Falsify::ShippingLine

Inherits:
Object
  • Object
show all
Defined in:
lib/falsify/models/order/shipping_line.rb

Overview

An individual shipping method used to fulfill an order.

Instance Attribute Summary collapse

Instance Attribute Details

#carrier_identifier ⇒ String

A reference to the carrier service that provided the rate. Present when the rate was computed by a third-party carrier service.

Returns:

  • (String) 


33
34
35
 
# File 'lib/falsify/models/order/shipping_line.rb', line 33

def carrier_identifier
  @carrier_identifier
end

#code ⇒ String

A reference to the shipping method.

Returns:

  • (String) 


6
7
8
 
# File 'lib/falsify/models/order/shipping_line.rb', line 6

def code
  @code
end

#discounted_price ⇒ String

The price of the shipping method after line-level discounts have been applied. Doesn't reflect cart-level or order-level discounts.

Returns:

  • (String) 


10
11
12
 
# File 'lib/falsify/models/order/shipping_line.rb', line 10

def discounted_price
  @discounted_price
end

#discounted_price_set ⇒ PriceSet

The price of the shipping method in both shop and presentment currencies after line-level discounts have been applied.

Returns:



13
14
15
 
# File 'lib/falsify/models/order/shipping_line.rb', line 13

def discounted_price_set
  @discounted_price_set
end

#price ⇒ String

The price of this shipping method in the shop currency. Can't be negative.

Returns:

  • (String) 


17
18
19
 
# File 'lib/falsify/models/order/shipping_line.rb', line 17

def price
  @price
end

#price_set ⇒ PriceSet

The price of the shipping method in shop and presentment currencies.

Returns:



20
21
22
 
# File 'lib/falsify/models/order/shipping_line.rb', line 20

def price_set
  @price_set
end

#requested_fulfillment_service_id ⇒ String?

A reference to the fulfillment service that is being requested for the shipping method. Present if the shipping method requires processing by a third party fulfillment service; null otherwise.

Returns:

  • (String, nil) 


37
38
39
 
# File 'lib/falsify/models/order/shipping_line.rb', line 37

def requested_fulfillment_service_id
  @requested_fulfillment_service_id
end

#source ⇒ String

The source of the shipping method.

Returns:

  • (String) 


23
24
25
 
# File 'lib/falsify/models/order/shipping_line.rb', line 23

def source
  @source
end

#tax_lines ⇒ Array<TaxLine>

A list of tax line objects, each of which details a tax applicable to this shipping line.

Returns:



29
30
31
 
# File 'lib/falsify/models/order/shipping_line.rb', line 29

def tax_lines
  @tax_lines
end

#title ⇒ String

The title of the shipping method.

Returns:

  • (String) 


26
27
28
 
# File 'lib/falsify/models/order/shipping_line.rb', line 26

def title
  @title
end