21f61ec160
Generated the following references: - `api_key_models` - `auth_models` - `cart_models` - `core_flows` - `currency_models` - `customer_models` - `file` - `file_service` - `fulfillment` - `fulfillment_models` - `helper_steps` - `inventory_next_models` - `js_sdk` - `module_events` - `modules` - `notification` - `notification_service` - `order` - `order_models` - `payment` - `payment_models` - `pricing_models` - `product_models` - `promotion` - `promotion_models` - `region_models` - `sales_channel_models` - `stock_location_next_models` - `store_models` - `tax_models` - `types` - `user_models` - `utils` - `workflows` --- > [!NOTE] > Regenerates documentation references with updated schemas/fields and source links, adds locking guidance to fulfillment delivery workflow, expands notification step IO, and tweaks examples/sample values. > > - **Docs Generation**: > - Regenerated reference pages across `core_flows`, `fulfillment`, `inventory`, `order`, etc., with updated TypeList schemas and examples. > - **Fulfillment Workflows/Steps**: > - Updated IO schemas (e.g., added `custom_display_id` on `OrderDTO`, `carry_over_promotions` on `OrderChangeDTO`). > - Added locking guidance and workflow steps (`acquireLockStep`/`releaseLockStep`) to `markFulfillmentAsDeliveredWorkflow` plus new note/tag. > - Refreshed example snippets and sample values. > - **Notification Step** (`sendNotificationsStep`): > - Input expanded with `from`, `content`, `provider_data`, `attachments`; `template` now optional. > - Output includes `provider_data` and `attachments` fields. > - **Order Steps/Workflows**: > - IO schemas updated to include `custom_display_id` and `carry_over_promotions` where applicable; added `ordering` on change actions. > - Example payloads adjusted (IDs, currencies, amounts). > - **Meta**: > - Updated `<SourceCodeLink>` URLs to new commit hashes throughout. > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit eeb0dac7b19d51860531a491208b2b3b853aa4db. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
49 lines
2.2 KiB
Plaintext
49 lines
2.2 KiB
Plaintext
---
|
|
displayed_sidebar: fulfillmentModelReference
|
|
slug: /references/fulfillment/models
|
|
---
|
|
|
|
import { TypeList } from "docs-ui"
|
|
|
|
# Fulfillment Module Data Models Reference
|
|
|
|
This documentation provides a reference to the data models in the Fulfillment Module
|
|
|
|
## Relations Overview
|
|
|
|
```mermaid
|
|
erDiagram
|
|
Fulfillment ||--|| FulfillmentItem : items
|
|
Fulfillment ||--|| FulfillmentLabel : labels
|
|
Fulfillment ||--|| FulfillmentProvider : provider
|
|
Fulfillment ||--|| FulfillmentAddress : delivery_address
|
|
FulfillmentSet ||--|| ServiceZone : service_zones
|
|
ServiceZone ||--|| GeoZone : geo_zones
|
|
ServiceZone ||--|| ShippingOption : shipping_options
|
|
ShippingOption ||--|| ShippingOptionRule : rules
|
|
ShippingOption ||--|| Fulfillment : fulfillments
|
|
ShippingOptionType ||--|| ShippingOption : shipping_options
|
|
ShippingProfile ||--|| ShippingOption : shipping_options
|
|
|
|
```
|
|
|
|
## Type Aliases
|
|
|
|
- [GeoZoneSchema](../../fulfillment_models/types/fulfillment_models.GeoZoneSchema/page.mdx)
|
|
- [ServiceZoneSchema](../../fulfillment_models/types/fulfillment_models.ServiceZoneSchema/page.mdx)
|
|
|
|
## Data Models
|
|
|
|
- [Fulfillment](../../fulfillment_models/variables/fulfillment_models.Fulfillment/page.mdx)
|
|
- [FulfillmentAddress](../../fulfillment_models/variables/fulfillment_models.FulfillmentAddress/page.mdx)
|
|
- [FulfillmentItem](../../fulfillment_models/variables/fulfillment_models.FulfillmentItem/page.mdx)
|
|
- [FulfillmentLabel](../../fulfillment_models/variables/fulfillment_models.FulfillmentLabel/page.mdx)
|
|
- [FulfillmentProvider](../../fulfillment_models/variables/fulfillment_models.FulfillmentProvider/page.mdx)
|
|
- [FulfillmentSet](../../fulfillment_models/variables/fulfillment_models.FulfillmentSet/page.mdx)
|
|
- [GeoZone](../../fulfillment_models/variables/fulfillment_models.GeoZone/page.mdx)
|
|
- [ServiceZone](../../fulfillment_models/variables/fulfillment_models.ServiceZone/page.mdx)
|
|
- [ShippingOption](../../fulfillment_models/variables/fulfillment_models.ShippingOption/page.mdx)
|
|
- [ShippingOptionRule](../../fulfillment_models/variables/fulfillment_models.ShippingOptionRule/page.mdx)
|
|
- [ShippingOptionType](../../fulfillment_models/variables/fulfillment_models.ShippingOptionType/page.mdx)
|
|
- [ShippingProfile](../../fulfillment_models/variables/fulfillment_models.ShippingProfile/page.mdx)
|