Description
The Fulfillment object represents one of the fulfillments/shipments of an Order.
ℹ️ Note
This object supports custom data via the data attribute.
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 |