DeliveryFulfillment

Type: schema

TypeScript Definition

DeliveryFulfillment: {{
            /**
             * @description discriminator enum property added by openapi-typescript
             * @enum {string}
             */
            fulfillment_type: "delivery";
            /** @enum {string} */
            readonly preference_type?: "user" | "auto";
            shipments: {
                id: string;
                shipping_provider_id: string;
                readonly shipping_provider_name?: string | null;
                courier_company_id?: string | null;
                readonly courier_company_name?: string | null;
            }[];
        };
        /** DeliveryOption */
}

OpenAPI Schema

{
  "title": "DeliveryFulfillment",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/DeliveryFulfillment",
    "description": "API reference for the DeliveryFulfillment schema"
  },
  "required": [
    "fulfillment_type",
    "shipments"
  ],
  "properties": {
    "fulfillment_type": {
      "type": "string",
      "const": "delivery"
    },
    "preference_type": {
      "type": "string",
      "enum": [
        "user",
        "auto"
      ],
      "readOnly": true
    },
    "shipments": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "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
          }
        },
        "required": [
          "id",
          "shipping_provider_id"
        ]
      }
    }
  }
}

---

Auto-generated from OpenAPI spec and TypeScript definitions