Fulfillment - Fulfillment Module Data Models Reference

This documentation provides a reference to the Fulfillment data model. It belongs to the Fulfillment Module.

idPrimaryKeyModifier<IdProperty>

The ID of the fulfillment.

location_idTextProperty

The ID of the location to fulfill items from.

requires_shippingBooleanProperty

Whether the fulfillment item requires shipping.

itemsHasMany<FulfillmentItem>

The associated items.

labelsHasMany<FulfillmentLabel>

The associated labels.

packed_atDateTimePropertyOptional

The date the fulfillment items were packed.

shipped_atDateTimePropertyOptional

The date the fulfillment items were shipped.

marked_shipped_byTextPropertyOptional

The ID of the user that marked this fulfillment as shipped.

created_byTextPropertyOptional

The ID of the user that created this fulfillment.

delivered_atDateTimePropertyOptional

The date the fulfillment items were delivered.

canceled_atDateTimePropertyOptional

The date the fulfillment was canceled.

dataJSONPropertyOptional

The data of the fulfillment useful for the associated fulfillment provider. Learn more in this documentation

providerHasOneWithForeignKey<FulfillmentProvider>Optional

The associated provider.

shipping_optionBelongsTo<ShippingOption>Optional

The associated shipping option.

delivery_addressHasOneWithForeignKey<FulfillmentAddress>Optional

The associated delivery address.

metadataJSONPropertyOptional

Holds custom data in key-value pairs.

Was this page helpful?