Skip to content

FreeShippingCouponPromotion ​

Type: schema

TypeScript Definition ​

typescript
FreeShippingCouponPromotion: {components["schemas"]["CouponPromotionCommonDetail"] & {
            /** @description Empty, or `null`, for free shipping on everything
}

Component References ​

ReferenceResolves To
components["schemas"]["CouponPromotionCommonDetail"]CouponPromotionCommonDetail

OpenAPI Schema ​

json
{
  "allOf": [
    {
      "$ref": "#/components/schemas/CouponPromotionCommonDetail"
    },
    {
      "type": "object",
      "required": [
        "details",
        "applies_to_product"
      ],
      "properties": {
        "details": {
          "description": "Empty, or `null`, for free shipping on everything; the sellers it's limited to when `applies_to_product` is `seller`.",
          "anyOf": [
            {
              "$ref": "#/components/schemas/FreeShippingDetails"
            },
            {
              "type": "null"
            },
            {
              "type": "object",
              "required": [
                "sellers"
              ],
              "properties": {
                "sellers": {
                  "description": "The marketplace sellers whose items ship free.",
                  "type": "array",
                  "items": {
                    "type": "string"
                  },
                  "minItems": 1
                },
                "products": {
                  "type": "array",
                  "maxItems": 0
                },
                "category_id": {
                  "type": "array",
                  "maxItems": 0
                }
              }
            }
          ]
        },
        "applies_to_product": {
          "description": "`seller` limits free shipping to specific marketplace sellers (`details.sellers`), on marketplace stores only.",
          "type": "string",
          "enum": [
            "all",
            "seller"
          ]
        }
      }
    }
  ],
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/FreeShippingCouponPromotion",
    "description": "API reference for the FreeShippingCouponPromotion schema"
  },
  "title": "FreeShippingCouponPromotion"
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: