Class: Falsify::FulfillmentLineItem

Inherits:
Object
  • Object
show all
Extended by:
Enumerize
Defined in:
lib/falsify/models/fulfillment/fulfillment_line_item.rb

Overview

A historical record of an individual item in a fulfillment.

Instance Attribute Summary collapse

Instance Attribute Details

#fulfillable_quantity ⇒ String

The amount available to fulfill. This is the quantity - max (refunded_quantity, fulfilled_quantity) - pending_fulfilled_quantity - open_fulfilled_quantity.

Returns:

  • (String) 


63
64
65
 
# File 'lib/falsify/models/fulfillment/fulfillment_line_item.rb', line 63

def fulfillable_quantity
  @fulfillable_quantity
end

#fulfillment_service ⇒ String

The service provider who is doing the fulfillment.

Returns:

  • (String) 


36
37
38
 
# File 'lib/falsify/models/fulfillment/fulfillment_line_item.rb', line 36

def fulfillment_service
  @fulfillment_service
end

#fulfillment_status ⇒ :fulfilled, ...

The status of an order in terms of the line items being fulfilled. Valid values: fulfilled, null, or partial.

Returns:

  • (:fulfilled, :null, :partial) 


70
 
# File 'lib/falsify/models/fulfillment/fulfillment_line_item.rb', line 70

enumerize :fulfillment_status, in: [:fulfilled, :null, :partial]

#gift_card ⇒ Boolean

Whether the line item is a gift card.

Returns:

  • (Boolean) 


48
49
50
 
# File 'lib/falsify/models/fulfillment/fulfillment_line_item.rb', line 48

def gift_card
  @gift_card
end

#grams ⇒ String

The weight of the item in grams.

Returns:

  • (String) 


24
25
26
 
# File 'lib/falsify/models/fulfillment/fulfillment_line_item.rb', line 24

def grams
  @grams
end

#id ⇒ String

The ID of the line item within the fulfillment.

Returns:

  • (String) 


9
10
11
 
# File 'lib/falsify/models/fulfillment/fulfillment_line_item.rb', line 9

def id
  @id
end

#name ⇒ String

The name of the product variant.

Returns:

  • (String) 


51
52
53
 
# File 'lib/falsify/models/fulfillment/fulfillment_line_item.rb', line 51

def name
  @name
end

#price ⇒ String

The price of the item.

Returns:

  • (String) 


21
22
23
 
# File 'lib/falsify/models/fulfillment/fulfillment_line_item.rb', line 21

def price
  @price
end

#product_exists ⇒ String

Whether the product exists.

Returns:

  • (String) 


60
61
62
 
# File 'lib/falsify/models/fulfillment/fulfillment_line_item.rb', line 60

def product_exists
  @product_exists
end

#product_id ⇒ String

The unique numeric identifier for the product in the fulfillment.

Returns:

  • (String) 


39
40
41
 
# File 'lib/falsify/models/fulfillment/fulfillment_line_item.rb', line 39

def product_id
  @product_id
end

#properties ⇒ Array<String>

Any additional properties associated with the line item.

Returns:

  • (Array<String>) 


57
58
59
 
# File 'lib/falsify/models/fulfillment/fulfillment_line_item.rb', line 57

def properties
  @properties
end

#quantity ⇒ Integer

The number of items in the fulfillment.

Returns:

  • (Integer) 


18
19
20
 
# File 'lib/falsify/models/fulfillment/fulfillment_line_item.rb', line 18

def quantity
  @quantity
end

#requires_shipping ⇒ Boolean

Whether a customer needs to provide a shipping address when placing an order for this product variant.

Returns:

  • (Boolean) 


42
43
44
 
# File 'lib/falsify/models/fulfillment/fulfillment_line_item.rb', line 42

def requires_shipping
  @requires_shipping
end

#sku ⇒ String

The unique identifier of the item in the fulfillment.

Returns:

  • (String) 


27
28
29
 
# File 'lib/falsify/models/fulfillment/fulfillment_line_item.rb', line 27

def sku
  @sku
end

#tax_lines ⇒ Array<TaxLine>

The title, price, and rate of any taxes applied to the line item.

Returns:



73
74
75
 
# File 'lib/falsify/models/fulfillment/fulfillment_line_item.rb', line 73

def tax_lines
  @tax_lines
end

#taxable ⇒ Boolean

Whether the line item is taxable.

Returns:

  • (Boolean) 


45
46
47
 
# File 'lib/falsify/models/fulfillment/fulfillment_line_item.rb', line 45

def taxable
  @taxable
end

#title ⇒ String

The title of the product.

Returns:

  • (String) 


15
16
17
 
# File 'lib/falsify/models/fulfillment/fulfillment_line_item.rb', line 15

def title
  @title
end

#total_discount ⇒ String

The total of any discounts applied to the line item.

Returns:

  • (String) 


66
67
68
 
# File 'lib/falsify/models/fulfillment/fulfillment_line_item.rb', line 66

def total_discount
  @total_discount
end

#variant_id ⇒ String

The ID of the product variant being fulfilled.

Returns:

  • (String) 


12
13
14
 
# File 'lib/falsify/models/fulfillment/fulfillment_line_item.rb', line 12

def variant_id
  @variant_id
end

#variant_inventory_management ⇒ String

The name of the inventory management system.

Returns:

  • (String) 


54
55
56
 
# File 'lib/falsify/models/fulfillment/fulfillment_line_item.rb', line 54

def variant_inventory_management
  @variant_inventory_management
end

#variant_title ⇒ String

The title of the product variant being fulfilled.

Returns:

  • (String) 


30
31
32
 
# File 'lib/falsify/models/fulfillment/fulfillment_line_item.rb', line 30

def variant_title
  @variant_title
end

#vendor ⇒ String

The name of the supplier of the item.

Returns:

  • (String) 


33
34
35
 
# File 'lib/falsify/models/fulfillment/fulfillment_line_item.rb', line 33

def vendor
  @vendor
end