PartialCollectAndDelivery

Type: schema

TypeScript Definition

PartialCollectAndDelivery: {{
            /**
             * @description discriminator enum property added by openapi-typescript
             * @enum {string}
             */
            fulfillment_type: "partial-collect-and-delivery";
            /** @enum {string} */
            readonly preference_type?: "user" | "auto";
            "collect-in-store": {
                pickup_location_id: string;
                readonly pickup_location_name?: string;
                items: components["schemas"]["FulfillmentItem"][];
            };
            delivery: {
                shipping_provider_id: string;
                readonly shipping_provider_name?: string | null;
                courier_company_id?: string | null;
                readonly courier_company_name?: string | null;
                items: components["schemas"]["FulfillmentItem"][];
            };
        };
        /** PauseSubscription */
}

Component References

Reference	Resolves To
components["schemas"]["FulfillmentItem"]	FulfillmentItem

OpenAPI Schema

{
  "title": "PartialCollectAndDelivery",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/PartialCollectAndDelivery",
    "description": "API reference for the PartialCollectAndDelivery schema"
  },
  "required": [
    "fulfillment_type",
    "collect-in-store",
    "delivery"
  ],
  "properties": {
    "fulfillment_type": {
      "type": "string",
      "const": "partial-collect-and-delivery"
    },
    "preference_type": {
      "type": "string",
      "enum": [
        "user",
        "auto"
      ],
      "readOnly": true
    },
    "collect-in-store": {
      "type": "object",
      "properties": {
        "pickup_location_id": {
          "type": "string"
        },
        "pickup_location_name": {
          "type": "string",
          "readOnly": true
        },
        "items": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/FulfillmentItem"
          }
        }
      },
      "required": [
        "items",
        "pickup_location_id"
      ]
    },
    "delivery": {
      "type": "object",
      "properties": {
        "shipping_provider_id": {
          "type": "string"
        },
        "shipping_provider_name": {
          "type": [
            "string",
            "null"
          ],
          "readOnly": true
        },
        "courier_company_id": {
          "type": [
            "string",
            "null"
          ]
        },
        "courier_company_name": {
          "type": [
            "string",
            "null"
          ],
          "readOnly": true
        },
        "items": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/FulfillmentItem"
          }
        }
      },
      "required": [
        "shipping_provider_id",
        "items"
      ]
    }
  }
}

---

Auto-generated from OpenAPI spec and TypeScript definitions