Class: Falsify::FulfillmentEvent

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

Overview

The FulfillmentEvent resource represents tracking events that belong to a Fulfillment of one or more items in an Order. Fulfillment events are displayed on the order status page to update customers on the status of their shipment. See the API documentation.

Instance Attribute Summary collapse

Instance Attribute Details

#address1 ⇒ String

The street address where the fulfillment event occurred.

Returns:

  • (String) 


11
12
13
 
# File 'lib/falsify/models/fulfillment/fulfillment_event.rb', line 11

def address1
  @address1
end

#city ⇒ String

The city where the fulfillment event occurred.

Returns:

  • (String) 


14
15
16
 
# File 'lib/falsify/models/fulfillment/fulfillment_event.rb', line 14

def city
  @city
end

#country ⇒ String

The country where the fulfillment event occurred.

Returns:

  • (String) 


17
18
19
 
# File 'lib/falsify/models/fulfillment/fulfillment_event.rb', line 17

def country
  @country
end

#created_at ⇒ String

The date and time (ISO 8601 format) when the fulfillment event was created.

Returns:

  • (String) 


20
21
22
 
# File 'lib/falsify/models/fulfillment/fulfillment_event.rb', line 20

def created_at
  @created_at
end

#estimated_delivery_at ⇒ String?

The estimated delivery date based on the fulfillment's tracking number, as long as it's provided by one of the following carriers: USPS, FedEx, UPS, or Canada Post (Canada only). Value is null if no tracking number is available or if the tracking number is from an unsupported carrier. This property is available only when carrier calculated rates are in use.'

Returns:

  • (String, nil) 


25
26
27
 
# File 'lib/falsify/models/fulfillment/fulfillment_event.rb', line 25

def estimated_delivery_at
  @estimated_delivery_at
end

#fulfillment_id ⇒ String

An ID for the fulfillment that's associated with the fulfillment event.

Returns:

  • (String) 


28
29
30
 
# File 'lib/falsify/models/fulfillment/fulfillment_event.rb', line 28

def fulfillment_id
  @fulfillment_id
end

#happened_at ⇒ String

The date and time (ISO 8601 format) when the fulfillment event occurred.

Returns:

  • (String) 


31
32
33
 
# File 'lib/falsify/models/fulfillment/fulfillment_event.rb', line 31

def happened_at
  @happened_at
end

#id ⇒ String

An ID for the fulfillment event.

Returns:

  • (String) 


34
35
36
 
# File 'lib/falsify/models/fulfillment/fulfillment_event.rb', line 34

def id
  @id
end

#latitude ⇒ String

A geographic coordinate specifying the latitude of the fulfillment event.

Returns:

  • (String) 


37
38
39
 
# File 'lib/falsify/models/fulfillment/fulfillment_event.rb', line 37

def latitude
  @latitude
end

#longitude ⇒ String

A geographic coordinate specifying the longitude of the fulfillment event.

Returns:

  • (String) 


40
41
42
 
# File 'lib/falsify/models/fulfillment/fulfillment_event.rb', line 40

def longitude
  @longitude
end

#message ⇒ String

An arbitrary message describing the status. Can be provided by a shipping carrier.

Returns:

  • (String) 


44
45
46
 
# File 'lib/falsify/models/fulfillment/fulfillment_event.rb', line 44

def message
  @message
end

#order_id ⇒ String

The ID of the order that's associated with the fulfillment event.

Returns:

  • (String) 


47
48
49
 
# File 'lib/falsify/models/fulfillment/fulfillment_event.rb', line 47

def order_id
  @order_id
end

#province ⇒ String

The province where the fulfillment event occurred.

Returns:

  • (String) 


50
51
52
 
# File 'lib/falsify/models/fulfillment/fulfillment_event.rb', line 50

def province
  @province
end

#shop_id ⇒ String

An ID for the shop that's associated with the fulfillment event.

Returns:

  • (String) 


53
54
55
 
# File 'lib/falsify/models/fulfillment/fulfillment_event.rb', line 53

def shop_id
  @shop_id
end

#status ⇒ :label_printed, ...

The status of the fulfillment event. Valid values:

  • label_printed - A label for the shipment was purchased and printed.
  • label_purchased - A label for the shipment was purchased, but not printed.
  • attempted_delivery - Delivery of the shipment was attempted, but unable to be completed.
  • ready_for_pickup - The shipment is ready for pickup at a shipping depot.
  • confirmed - The carrier is aware of the shipment, but hasn't received it yet.
  • in_transit - The shipment is being transported between shipping facilities on the way to its destination.
  • out_for_delivery - The shipment is being delivered to its final destination.
  • delivered - The shipment was succesfully delivered.
  • failure - Something went wrong when pulling tracking information for the shipment, such as the tracking number was invalid or the shipment was canceled.

Returns:

  • (:label_printed, :label_purchased, :attempted_delivery, :ready_for_pickup, :confirmed, :in_transit, :out_for_delivery, :delivered, :failure) 


67
 
# File 'lib/falsify/models/fulfillment/fulfillment_event.rb', line 67

enumerize :status, in: [:label_printed, :label_purchased, :attempted_delivery, :ready_for_pickup, :confirmed, :in_transit, :out_for_delivery, :delivered, :failure]

#updated_at ⇒ String

The date and time (ISO 8601 format) when the fulfillment event was updated.

Returns:

  • (String) 


70
71
72
 
# File 'lib/falsify/models/fulfillment/fulfillment_event.rb', line 70

def updated_at
  @updated_at
end

#zip ⇒ String

The zip code of the location where the fulfillment event occurred.

Returns:

  • (String) 


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

def zip
  @zip
end