Skip to content
Log in

Fulfillment - Liquid Object Reference

On this page

Description

The Fulfillment object represents one of the fulfillments/shipments of an Order.

:::note This object supports custom data via the data attribute. :::

Backed by

This drop renders the s_c__Shipment__c Salesforce object. A theme writes it as fulfillment.

Liquid attribute Salesforce field
fulfillment_type s_c__Fulfillment_Type__c
last_lodgement_error_at s_c__Last_Error_At__c
notes s_c__Notes__c
reference s_c__Reference__c
shipping_charge s_c__Charge__c
shipping_cost s_c__Cost__c
shipping_provider_name s_c__Provider__c
shipping_provider_service s_c__Provider_Service__c
status s_c__State__c
status_changed_at s_c__State_Changed_At__c
tracking_code s_c__Tracking_Code__c
tracking_provider s_c__Tracking_Provider__c
tracking_public_url s_c__Tracking_Public_Url__c
tracking_status s_c__Tracking_Status__c
tracking_tracker_uid s_c__Tracking_Tracker_Uid__c
tracking_updated_at s_c__Tracking_Updated_At__c

Every other attribute on this drop is derived by StoreConnect rather than read straight from one field. The Attributes section lists them all.

Fields you add yourself are not listed above. Expose one with a Custom Data Mapping record, then read it from fulfillment.data. See custom data fields in Liquid.

Attributes

Attribute Type Description
fulfillment_type String Returns the type of this Fulfillment, e.g. takeaway, delivery
id String Returns the unique id for this Fulfillment
last_lodgement_error_at Timestamp Returns the date/time when this Fulfillment last had an error lodging with a Shipping Provider
lodgement_errors String Returns any errors lodging this Fulfillment with a Shipping Provider
notes String Returns any notes related to this Fulfillment
path String Returns the link path for this Fulfillment
reference String Returns the public reference code for this Fulfillment
status String Returns the status of this Fulfillment, e.g. ready_to_ship,waiting_for_pick_up
status_changed_at Timestamp Returns the date/time the status last changed for this Fulfillment record
stock_location StockLocation Returns the Stock Location from which this Fulfillment was sent

Order

Attributes related to the Order that this Fulfillment belongs to

Attribute Type Description
fulfillment_items List[FulfillmentItem] Returns a list of Fulfillment Items for this Fulfillment
order Order Returns the Order that this Fulfillment belongs to

Shipping Provider

Attributes related to lodging this Fulfillment with a Shipping Provider

Attribute Type Description
shipping_charge Number Returns the order’s total charge for shipping
shipping_cost Number Returns the internal shipping cost for this Fulfillment if sent via Shipping Provider
shipping_provider_name String Returns the name of the Shipping Provider to whom this Fulfillment was lodged
shipping_provider_service String Returns the name of the Shipping Provider Service used to lodge this Fulfillment
shipping_rate ShippingRate Returns the custom Shipping Rate selected for the Order

Tracking

Attributes related to tracking the Shipment

Attribute Type Description
tracking_code String Returns the tracking code for this Fulfillment
tracking_provider String Returns the tracking provider for this Fulfillment
tracking_public_url String Returns the public url for this Fulfillment
tracking_status String Returns the status of this Fulfillment
tracking_tracker_uid String Returns the tracker uid for this Fulfillment
tracking_updated_at Timestamp Returns the timestamp for when this Fulfillment was last updated
tracking? Boolean Returns true if shipment tracking is enabled for this Fulfillment

Available on

Was this article helpful?

Was this article helpful?