Package io.deeplumen.ucp.models.schemas.shopping

Class FulfillmentEvent

java.lang.Object
io.deeplumen.ucp.models.schemas.shopping.FulfillmentEvent
@Generated("jsonschema2pojo") public class FulfillmentEvent extends Object
Fulfillment Event

Append-only fulfillment event representing an actual shipment. References line items by ID.

  • Constructor Details

    • FulfillmentEvent

      public FulfillmentEvent()

  • Method Details

    • getId

      public String getId()
      Fulfillment event identifier. (Required)

    • setId

      public void setId(String id)
      Fulfillment event identifier. (Required)

    • withId

      public FulfillmentEvent withId(String id)

    • getOccurredAt

      public Date getOccurredAt()
      RFC 3339 timestamp when this fulfillment event occurred. (Required)

    • setOccurredAt

      public void setOccurredAt(Date occurredAt)
      RFC 3339 timestamp when this fulfillment event occurred. (Required)

    • withOccurredAt

      public FulfillmentEvent withOccurredAt(Date occurredAt)

    • getType

      public String getType()
      Fulfillment event type. Common values include: processing (preparing to ship), shipped (handed to carrier), in_transit (in delivery network), delivered (received by buyer), failed_attempt (delivery attempt failed), canceled (fulfillment canceled), undeliverable (cannot be delivered), returned_to_sender (returned to merchant). (Required)

    • setType

      public void setType(String type)
      Fulfillment event type. Common values include: processing (preparing to ship), shipped (handed to carrier), in_transit (in delivery network), delivered (received by buyer), failed_attempt (delivery attempt failed), canceled (fulfillment canceled), undeliverable (cannot be delivered), returned_to_sender (returned to merchant). (Required)

    • withType

      public FulfillmentEvent withType(String type)

    • getLineItems

      public List<LineItem__1> getLineItems()
      Which line items and quantities are fulfilled in this event. (Required)

    • setLineItems

      public void setLineItems(List<LineItem__1> lineItems)
      Which line items and quantities are fulfilled in this event. (Required)

    • withLineItems

      public FulfillmentEvent withLineItems(List<LineItem__1> lineItems)

    • getTrackingNumber

      public String getTrackingNumber()
      Carrier tracking number (required if type != processing).

    • setTrackingNumber

      public void setTrackingNumber(String trackingNumber)
      Carrier tracking number (required if type != processing).

    • withTrackingNumber

      public FulfillmentEvent withTrackingNumber(String trackingNumber)

    • getTrackingUrl

      public URI getTrackingUrl()
      URL to track this shipment (required if type != processing).

    • setTrackingUrl

      public void setTrackingUrl(URI trackingUrl)
      URL to track this shipment (required if type != processing).

    • withTrackingUrl

      public FulfillmentEvent withTrackingUrl(URI trackingUrl)

    • getCarrier

      public String getCarrier()
      Carrier name (e.g., 'FedEx', 'USPS').

    • setCarrier

      public void setCarrier(String carrier)
      Carrier name (e.g., 'FedEx', 'USPS').

    • withCarrier

      public FulfillmentEvent withCarrier(String carrier)

    • getDescription

      public String getDescription()
      Human-readable description of the shipment status or delivery information (e.g., 'Delivered to front door', 'Out for delivery').

    • setDescription

      public void setDescription(String description)
      Human-readable description of the shipment status or delivery information (e.g., 'Delivered to front door', 'Out for delivery').

    • withDescription

      public FulfillmentEvent withDescription(String description)

    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()

    • setAdditionalProperty

      public void setAdditionalProperty(String name, Object value)

    • withAdditionalProperty

      public FulfillmentEvent withAdditionalProperty(String name, Object value)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object other)
      Overrides:
      equals in class Object