Skip to content

FulfillmentPreference

Type: schema

Description

How the customer wants to receive their order. Discriminated by fulfillment_type: delivery for home delivery, collect-in-store for in-store pickup, or partial-collect-and-delivery for a mix of both.

TypeScript Definition

typescript
FulfillmentPreference: components["schemas"]["CollectInStoreFulfillment"] | components["schemas"]["DeliveryFulfillment"] | components["schemas"]["PartialCollectAndDelivery"]

Component References

ReferenceResolves To
components["schemas"]["CollectInStoreFulfillment"]CollectInStoreFulfillment
components["schemas"]["DeliveryFulfillment"]DeliveryFulfillment
components["schemas"]["PartialCollectAndDelivery"]PartialCollectAndDelivery

OpenAPI Schema

json
{
  "title": "FulfillmentPreference",
  "description": "How the customer wants to receive their order. Discriminated by `fulfillment_type`: `delivery` for home delivery, `collect-in-store` for in-store pickup, or `partial-collect-and-delivery` for a mix of both.",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/FulfillmentPreference",
    "description": "API reference for the FulfillmentPreference schema"
  },
  "discriminator": {
    "propertyName": "fulfillment_type",
    "mapping": {
      "collect-in-store": "#/components/schemas/CollectInStoreFulfillment",
      "delivery": "#/components/schemas/DeliveryFulfillment",
      "partial-collect-and-delivery": "#/components/schemas/PartialCollectAndDelivery"
    }
  },
  "oneOf": [
    {
      "$ref": "#/components/schemas/CollectInStoreFulfillment"
    },
    {
      "$ref": "#/components/schemas/DeliveryFulfillment"
    },
    {
      "$ref": "#/components/schemas/PartialCollectAndDelivery"
    }
  ],
  "x-tags": [
    "Carts"
  ]
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: