Skip to main content
Glama

Create a promotion

create_promotion
Destructive

Creates shop or membership promotions, including codes, discounts, tiers, and usage limits, for Fourthwall shops.

Instructions

Rate limit: 100 requests / 10 seconds per shop. See Rate limiting.

Creates a promotion

Input Schema

NameRequiredDescriptionDefault
accountNoExact private shop profile label; not a provider identity or authorization proof.
confirmNoSet true only when the user asked for exactly this action.
payloadNoComplete current native JSON body; cannot mix with native body flags or payload_file.
payload_fileNoAbsolute regular non-symlink native JSON body file, at most1MiB. Cannot mix with payload or body flags.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv3.0.0
    • addedInput schema / $defs
      Added value: +{
      +  "Open_Api_Promotion_Selected_Products": {
      +    "properties": {
      +      "oncePerOrder": {
      +        "type": "boolean"
      +      },
      +      "productIds": {
      +        "items": {
      +          "format": "uuid",
      +          "type": "string"
      +        },
      +        "type": "array"
      +      }
      +    },
      +    "required": [
      +      "productIds"
      +    ],
      +    "title": "Open Api Promotion Selected Products",
      +    "type": "object"
      +  },
      +  "Shop": {
      +    "properties": {
      +      "minimumOrderValue": {
      +        "properties": {
      +          "currency": {
      +            "type": "string"
      +          },
      +          "value": {
      +            "minimum": 0,
      +            "type": "number"
      +          }
      +        },
      +        "required": [
      +          "currency",
      +          "value"
      +        ],
      +        "title": "Money",
      +        "type": "object"
      +      }
      +    },
      +    "title": "Shop",
      +    "type": "object"
      +  },
      +  "discount": {
      +    "oneOf": [
      +      {
      +        "allOf": [
      +          {
      +            "properties": {
      +              "type": {
      +                "type": "string"
      +              }
      +            },
      +            "required": [
      +              "type"
      +            ],
      +            "title": "Shop"
      +          },
      +          {
      +            "properties": {
      +              "freeShipping": {
      +                "type": "boolean"
      +              },
      +              "money": {
      +                "properties": {
      +                  "currency": {
      +                    "type": "string"
      +                  },
      +                  "value": {
      +                    "minimum": 0,
      +                    "type": "number"
      +                  }
      +                },
      +                "required": [
      +                  "currency",
      +                  "value"
      +                ],
      +                "title": "Money",
      +                "type": "object"
      +              }
      +            },
      +            "type": "object"
      +          },
      +          {
      +            "properties": {
      +              "type": {
      +                "const": "FLAT_RATE",
      +                "type": "string"
      +              }
      +            },
      +            "type": "object"
      +          }
      +        ],
      +        "required": [
      +          "freeShipping",
      +          "money"
      +        ],
      +        "title": "Fixed Amount"
      +      },
      +      {
      +        "allOf": [
      +          {
      +            "properties": {
      +              "type": {
      +                "type": "string"
      +              }
      +            },
      +            "required": [
      +              "type"
      +            ],
      +            "title": "Shop"
      +          },
      +          {
      +            "properties": {
      +              "type": {
      +                "const": "FREE_SHIPPING",
      +                "type": "string"
      +              }
      +            },
      +            "type": "object"
      +          }
      +        ],
      +        "title": "Free Shipping"
      +      },
      +      {
      +        "allOf": [
      +          {
      +            "properties": {
      +              "type": {
      +                "type": "string"
      +              }
      +            },
      +            "required": [
      +              "type"
      +            ],
      +            "title": "Shop"
      +          },
      +          {
      +            "properties": {
      +              "percentage": {
      +                "type": "number"
      +              },
      +              "shipping": {
      +                "enum": [
      +                  "Excluded",
      +                  "Included",
      +                  "FreeLowestOnly",
      +                  "Free"
      +                ],
      +                "type": "string"
      +              }
      +            },
      +            "type": "object"
      +          },
      +          {
      +            "properties": {
      +              "type": {
      +                "const": "PERCENTAGE",
      +                "type": "string"
      +              }
      +            },
      +            "type": "object"
      +          }
      +        ],
      +        "required": [
      +          "percentage",
      +          "shipping"
      +        ],
      +        "title": "Percentage"
      +      }
      +    ]
      +  },
      +  "discount_2": {
      +    "oneOf": [
      +      {
      +        "allOf": [
      +          {
      +            "properties": {
      +              "type": {
      +                "type": "string"
      +              }
      +            },
      +            "required": [
      +              "type"
      +            ],
      +            "title": "Memberships"
      +          },
      +          {
      +            "properties": {
      +              "percentage": {
      +                "type": "number"
      +              }
      +            },
      +            "type": "object"
      +          },
      +          {
      +            "properties": {
      +              "type": {
      +                "const": "PERCENTAGE",
      +                "type": "string"
      +              }
      +            },
      +            "type": "object"
      +          }
      +        ],
      +        "required": [
      +          "percentage"
      +        ],
      +        "title": "Percentage"
      +      }
      +    ]
      +  },
      +  "subscriptionType": {
      +    "oneOf": [
      +      {
      +        "allOf": [
      +          {
      +            "properties": {
      +              "type": {
      +                "type": "string"
      +              }
      +            },
      +            "required": [
      +              "type"
      +            ],
      +            "title": "Open Api Promotion Membership Subscription Type Applies To"
      +          },
      +          {
      +            "properties": {
      +              "type": {
      +                "const": "ALL",
      +                "type": "string"
      +              }
      +            },
      +            "type": "object"
      +          }
      +        ],
      +        "title": "All Members"
      +      },
      +      {
      +        "allOf": [
      +          {
      +            "properties": {
      +              "type": {
      +                "type": "string"
      +              }
      +            },
      +            "required": [
      +              "type"
      +            ],
      +            "title": "Open Api Promotion Membership Subscription Type Applies To"
      +          },
      +          {
      +            "properties": {
      +              "type": {
      +                "const": "ANNUAL",
      +                "type": "string"
      +              }
      +            },
      +            "type": "object"
      +          }
      +        ],
      +        "title": "Annual Members Only"
      +      },
      +      {
      +        "allOf": [
      +          {
      +            "properties": {
      +              "type": {
      +                "type": "string"
      +              }
      +            },
      +            "required": [
      +              "type"
      +            ],
      +            "title": "Open Api Promotion Membership Subscription Type Applies To"
      +          },
      +          {
      +            "properties": {
      +              "type": {
      +                "const": "MONTHLY",
      +                "type": "string"
      +              }
      +            },
      +            "type": "object"
      +          }
      +        ],
      +        "title": "Monthly Members Only"
      +      }
      +    ]
      +  },
      +  "tiers": {
      +    "oneOf": [
      +      {
      +        "allOf": [
      +          {
      +            "properties": {
      +              "type": {
      +                "type": "string"
      +              }
      +            },
      +            "required": [
      +              "type"
      +            ],
      +            "title": "Open Api Promotion Membership Tiers Applies To"
      +          },
      +          {
      +            "properties": {
      +              "type": {
      +                "const": "ALL",
      +                "type": "string"
      +              }
      +            },
      +            "type": "object"
      +          }
      +        ],
      +        "title": "All Tiers"
      +      },
      +      {
      +        "allOf": [
      +          {
      +            "properties": {
      +              "type": {
      +                "type": "string"
      +              }
      +            },
      +            "required": [
      +              "type"
      +            ],
      +            "title": "Open Api Promotion Membership Tiers Applies To"
      +          },
      +          {
      +            "properties": {
      +              "ids": {
      +                "items": {
      +                  "type": "string"
      +                },
      +                "type": "array"
      +              }
      +            },
      +            "type": "object"
      +          },
      +          {
      +            "properties": {
      +              "type": {
      +                "const": "SELECTED",
      +                "type": "string"
      +              }
      +            },
      +            "type": "object"
      +          }
      +        ],
      +        "required": [
      +          "ids"
      +        ],
      +        "title": "Selected Tiers"
      +      }
      +    ]
      +  }
      +}
    • changedInput schema / properties / confirm / description
      Previous value: -"Explicit approval for this exact provider effect or local private-file operation."New value: +"Set true only when the user asked for exactly this action."
    • changedInput schema / properties / payload / oneOf
      Previous value: -[
      -  {
      -    "allOf": [
      -      {
      -        "properties": {
      -          "type": {
      -            "type": "string"
      -          }
      -        },
      -        "required": [
      -          "type"
      -        ],
      -        "title": "Open Api Create Promotion Request"
      -      },
      -      {
      -        "properties": {
      -          "codes": {
      -            "items": {
      -              "type": "string"
      -            },
      -            "type": "array"
      -          },
      -          "discount": {
      -            "oneOf": [
      -              {
      -                "allOf": [
      -                  {
      -                    "properties": {
      -                      "type": {
      -                        "type": "string"
      -                      }
      -                    },
      -                    "required": [
      -                      "type"
      -                    ],
      -                    "title": "Memberships"
      -                  },
      -                  {
      -                    "properties": {
      -                      "percentage": {
      -                        "type": "number"
      -                      }
      -                    },
      -                    "type": "object"
      -                  },
      -                  {
      -                    "properties": {
      -                      "type": {
      -                        "const": "PERCENTAGE",
      -                        "type": "string"
      -                      }
      -                    },
      -                    "type": "object"
      -                  }
      -                ],
      -                "required": [
      -                  "percentage"
      -                ],
      -                "title": "Percentage"
      -              }
      -            ]
      -          },
      -          "requirements": {
      -            "properties": {
      -              "newMembersOnly": {
      -                "type": "boolean"
      -              }
      -            },
      -            "required": [
      -              "newMembersOnly"
      -            ],
      -            "title": "Memberships",
      -            "type": "object"
      -          },
      -          "subscriptionType": {
      -            "oneOf": [
      -              {
      -                "allOf": [
      -                  {
      -                    "properties": {
      -                      "type": {
      -                        "type": "string"
      -                      }
      -                    },
      -                    "required": [
      -                      "type"
      -                    ],
      -                    "title": "Open Api Promotion Membership Subscription Type Applies To"
      -                  },
      -                  {
      -                    "properties": {
      -                      "type": {
      -                        "const": "ALL",
      -                        "type": "string"
      -                      }
      -                    },
      -                    "type": "object"
      -                  }
      -                ],
      -                "title": "All Members"
      -              },
      -              {
      -                "allOf": [
      -                  {
      -                    "properties": {
      -                      "type": {
      -                        "type": "string"
      -                      }
      -                    },
      -                    "required": [
      -                      "type"
      -                    ],
      -                    "title": "Open Api Promotion Membership Subscription Type Applies To"
      -                  },
      -                  {
      -                    "properties": {
      -                      "type": {
      -                        "const": "ANNUAL",
      -                        "type": "string"
      -                      }
      -                    },
      -                    "type": "object"
      -                  }
      -                ],
      -                "title": "Annual Members Only"
      -              },
      -              {
      -                "allOf": [
      -                  {
      -                    "properties": {
      -                      "type": {
      -                        "type": "string"
      -                      }
      -                    },
      -                    "required": [
      -                      "type"
      -                    ],
      -                    "title": "Open Api Promotion Membership Subscription Type Applies To"
      -                  },
      -                  {
      -                    "properties": {
      -                      "type": {
      -                        "const": "MONTHLY",
      -                        "type": "string"
      -                      }
      -                    },
      -                    "type": "object"
      -                  }
      -                ],
      -                "title": "Monthly Members Only"
      -              }
      -            ]
      -          },
      -          "tiers": {
      -            "oneOf": [
      -              {
      -                "allOf": [
      -                  {
      -                    "properties": {
      -                      "type": {
      -                        "type": "string"
      -                      }
      -                    },
      -                    "required": [
      -                      "type"
      -                    ],
      -                    "title": "Open Api Promotion Membership Tiers Applies To"
      -                  },
      -                  {
      -                    "properties": {
      -                      "type": {
      -                        "const": "ALL",
      -                        "type": "string"
      -                      }
      -                    },
      -                    "type": "object"
      -                  }
      -                ],
      -                "title": "All Tiers"
      -              },
      -              {
      -                "allOf": [
      -                  {
      -                    "properties": {
      -                      "type": {
      -                        "type": "string"
      -                      }
      -                    },
      -                    "required": [
      -                      "type"
      -                    ],
      -                    "title": "Open Api Promotion Membership Tiers Applies To"
      -                  },
      -                  {
      -                    "properties": {
      -                      "ids": {
      -                        "items": {
      -                          "type": "string"
      -                        },
      -                        "type": "array"
      -                      }
      -                    },
      -                    "type": "object"
      -                  },
      -                  {
      -                    "properties": {
      -                      "type": {
      -                        "const": "SELECTED",
      -                        "type": "string"
      -                      }
      -                    },
      -                    "type": "object"
      -                  }
      -                ],
      -                "required": [
      -                  "ids"
      -                ],
      -                "title": "Selected Tiers"
      -              }
      -            ]
      -          }
      -        },
      -        "type": "object"
      -      },
      -      {
      -        "properties": {
      -          "type": {
      -            "const": "MEMBERSHIPS_MULTI",
      -            "type": "string"
      -          }
      -        },
      -        "type": "object"
      -      }
      -    ],
      -    "required": [
      -      "codes",
      -      "discount"
      -    ],
      -    "title": "MEMBERSHIPS_MULTI"
      -  },
      -  {
      -    "allOf": [
      -      {
      -        "properties": {
      -          "type": {
      -            "type": "string"
      -          }
      -        },
      -        "required": [
      -          "type"
      -        ],
      -        "title": "Open Api Create Promotion Request"
      -      },
      -      {
      -        "properties": {
      -          "code": {
      -            "type": "string"
      -          },
      -          "discount": {
      -            "oneOf": [
      -              {
      -                "allOf": [
      -                  {
      -                    "properties": {
      -                      "type": {
      -                        "type": "string"
      -                      }
      -                    },
      -                    "required": [
      -                      "type"
      -                    ],
      -                    "title": "Memberships"
      -                  },
      -                  {
      -                    "properties": {
      -                      "percentage": {
      -                        "type": "number"
      -                      }
      -                    },
      -                    "type": "object"
      -                  },
      -                  {
      -                    "properties": {
      -                      "type": {
      -                        "const": "PERCENTAGE",
      -                        "type": "string"
      -                      }
      -                    },
      -                    "type": "object"
      -                  }
      -                ],
      -                "required": [
      -                  "percentage"
      -                ],
      -                "title": "Percentage"
      -              }
      -            ]
      -          },
      -          "requirements": {
      -            "properties": {
      -              "newMembersOnly": {
      -                "type": "boolean"
      -              }
      -            },
      -            "required": [
      -              "newMembersOnly"
      -            ],
      -            "title": "Memberships",
      -            "type": "object"
      -          },
      -          "subscriptionType": {
      -            "oneOf": [
      -              {
      -                "allOf": [
      -                  {
      -                    "properties": {
      -                      "type": {
      -                        "type": "string"
      -                      }
      -                    },
      -                    "required": [
      -                      "type"
      -                    ],
      -                    "title": "Open Api Promotion Membership Subscription Type Applies To"
      -                  },
      -                  {
      -                    "properties": {
      -                      "type": {
      -                        "const": "ALL",
      -                        "type": "string"
      -                      }
      -                    },
      -                    "type": "object"
      -                  }
      -                ],
      -                "title": "All Members"
      -              },
      -              {
      -                "allOf": [
      -                  {
      -                    "properties": {
      -                      "type": {
      -                        "type": "string"
      -                      }
      -                    },
      -                    "required": [
      -                      "type"
      -                    ],
      -                    "title": "Open Api Promotion Membership Subscription Type Applies To"
      -                  },
      -                  {
      -                    "properties": {
      -                      "type": {
      -                        "const": "ANNUAL",
      -                        "type": "string"
      -                      }
      -                    },
      -                    "type": "object"
      -                  }
      -                ],
      -                "title": "Annual Members Only"
      -              },
      -              {
      -                "allOf": [
      -                  {
      -                    "properties": {
      -                      "type": {
      -                        "type": "string"
      -                      }
      -                    },
      -                    "required": [
      -                      "type"
      -                    ],
      -                    "title": "Open Api Promotion Membership Subscription Type Applies To"
      -                  },
      -                  {
      -                    "properties": {
      -                      "type": {
      -                        "const": "MONTHLY",
      -                        "type": "string"
      -                      }
      -                    },
      -                    "type": "object"
      -                  }
      -                ],
      -                "title": "Monthly Members Only"
      -              }
      -            ]
      -          },
      -          "tiers": {
      -            "oneOf": [
      -              {
      -                "allOf": [
      -                  {
      -                    "properties": {
      -                      "type": {
      -                        "type": "string"
      -                      }
      -                    },
      -                    "required": [
      -                      "type"
      -                    ],
      -                    "title": "Open Api Promotion Membership Tiers Applies To"
      -                  },
      -                  {
      -                    "properties": {
      -                      "type": {
      -                        "const": "ALL",
      -                        "type": "string"
      -                      }
      -                    },
      -                    "type": "object"
      -                  }
      -                ],
      -                "title": "All Tiers"
      -              },
      -              {
      -                "allOf": [
      -                  {
      -                    "properties": {
      -                      "type": {
      -                        "type": "string"
      -                      }
      -                    },
      -                    "required": [
      -                      "type"
      -                    ],
      -                    "title": "Open Api Promotion Membership Tiers Applies To"
      -                  },
      -                  {
      -                    "properties": {
      -                      "ids": {
      -                        "items": {
      -                          "type": "string"
      -                        },
      -                        "type": "array"
      -                      }
      -                    },
      -                    "type": "object"
      -                  },
      -                  {
      -                    "properties": {
      -                      "type": {
      -                        "const": "SELECTED",
      -                        "type": "string"
      -                      }
      -                    },
      -                    "type": "object"
      -                  }
      -                ],
      -                "required": [
      -                  "ids"
      -                ],
      -                "title": "Selected Tiers"
      -              }
      -            ]
      -          }
      -        },
      -        "type": "object"
      -      },
      -      {
      -        "properties": {
      -          "type": {
      -            "const": "MEMBERSHIPS_SINGLE",
      -            "type": "string"
      -          }
      -        },
      -        "type": "object"
      -      }
      -    ],
      -    "required": [
      -      "code",
      -      "discount"
      -    ],
      -    "title": "MEMBERSHIPS_SINGLE"
      -  },
      -  {
      -    "allOf": [
      -      {
      -        "properties": {
      -          "type": {
      -            "type": "string"
      -          }
      -        },
      -        "required": [
      -          "type"
      -        ],
      -        "title": "Open Api Create Promotion Request"
      -      },
      -      {
      -        "properties": {
      -          "appliesToProducts": {
      -            "properties": {
      -              "oncePerOrder": {
      -                "type": "boolean"
      -              },
      -              "productIds": {
      -                "items": {
      -                  "format": "uuid",
      -                  "type": "string"
      -                },
      -                "type": "array"
      -              }
      -            },
      -            "required": [
      -              "productIds"
      -            ],
      -            "title": "Open Api Promotion Selected Products",
      -            "type": "object"
      -          },
      -          "codes": {
      -            "items": {
      -              "type": "string"
      -            },
      -            "type": "array"
      -          },
      -          "discount": {
      -            "oneOf": [
      -              {
      -                "allOf": [
      -                  {
      -                    "properties": {
      -                      "type": {
      -                        "type": "string"
      -                      }
      -                    },
      -                    "required": [
      -                      "type"
      -                    ],
      -                    "title": "Shop"
      -                  },
      -                  {
      -                    "properties": {
      -                      "freeShipping": {
      -                        "type": "boolean"
      -                      },
      -                      "money": {
      -                        "properties": {
      -                          "currency": {
      -                            "type": "string"
      -                          },
      -                          "value": {
      -                            "minimum": 0,
      -                            "type": "number"
      -                          }
      -                        },
      -                        "required": [
      -                          "currency",
      -                          "value"
      -                        ],
      -                        "title": "Money",
      -                        "type": "object"
      -                      }
      -                    },
      -                    "type": "object"
      -                  },
      -                  {
      -                    "properties": {
      -                      "type": {
      -                        "const": "FLAT_RATE",
      -                        "type": "string"
      -                      }
      -                    },
      -                    "type": "object"
      -                  }
      -                ],
      -                "required": [
      -                  "freeShipping",
      -                  "money"
      -                ],
      -                "title": "Fixed Amount"
      -              },
      -              {
      -                "allOf": [
      -                  {
      -                    "properties": {
      -                      "type": {
      -                        "type": "string"
      -                      }
      -                    },
      -                    "required": [
      -                      "type"
      -                    ],
      -                    "title": "Shop"
      -                  },
      -                  {
      -                    "properties": {
      -                      "type": {
      -                        "const": "FREE_SHIPPING",
      -                        "type": "string"
      -                      }
      -                    },
      -                    "type": "object"
      -                  }
      -                ],
      -                "title": "Free Shipping"
      -              },
      -              {
      -                "allOf": [
      -                  {
      -                    "properties": {
      -                      "type": {
      -                        "type": "string"
      -                      }
      -                    },
      -                    "required": [
      -                      "type"
      -                    ],
      -                    "title": "Shop"
      -                  },
      -                  {
      -                    "properties": {
      -                      "percentage": {
      -                        "type": "number"
      -                      },
      -                      "shipping": {
      -                        "enum": [
      -                          "Excluded",
      -                          "Included",
      -                          "FreeLowestOnly",
      -                          "Free"
      -                        ],
      -                        "type": "string"
      -                      }
      -                    },
      -                    "type": "object"
      -                  },
      -                  {
      -                    "properties": {
      -                      "type": {
      -                        "const": "PERCENTAGE",
      -                        "type": "string"
      -                      }
      -                    },
      -                    "type": "object"
      -                  }
      -                ],
      -                "required": [
      -                  "percentage",
      -                  "shipping"
      -                ],
      -                "title": "Percentage"
      -              }
      -            ]
      -          },
      -          "limits": {
      -            "properties": {
      -              "maximumUse": {
      -                "format": "int32",
      -                "type": "integer"
      -              },
      -              "oneUsePerCustomer": {
      -                "type": "boolean"
      -              }
      -            },
      -            "required": [
      -              "oneUsePerCustomer"
      -            ],
      -            "title": "Open Api Promotion Limits",
      -            "type": "object"
      -          },
      -          "requirements": {
      -            "properties": {
      -              "minimumOrderValue": {
      -                "properties": {
      -                  "currency": {
      -                    "type": "string"
      -                  },
      -                  "value": {
      -                    "minimum": 0,
      -                    "type": "number"
      -                  }
      -                },
      -                "required": [
      -                  "currency",
      -                  "value"
      -                ],
      -                "title": "Money",
      -                "type": "object"
      -              }
      -            },
      -            "title": "Shop",
      -            "type": "object"
      -          }
      -        },
      -        "type": "object"
      -      },
      -      {
      -        "properties": {
      -          "type": {
      -            "const": "SHOP_MULTI",
      -            "type": "string"
      -          }
      -        },
      -        "type": "object"
      -      }
      -    ],
      -    "required": [
      -      "codes",
      -      "discount"
      -    ],
      -    "title": "SHOP_MULTI"
      -  },
      -  {
      -    "allOf": [
      -      {
      -        "properties": {
      -          "type": {
      -            "type": "string"
      -          }
      -        },
      -        "required": [
      -          "type"
      -        ],
      -        "title": "Open Api Create Promotion Request"
      -      },
      -      {
      -        "properties": {
      -          "appliesToProducts": {
      -            "properties": {
      -              "oncePerOrder": {
      -                "type": "boolean"
      -              },
      -              "productIds": {
      -                "items": {
      -                  "format": "uuid",
      -                  "type": "string"
      -                },
      -                "type": "array"
      -              }
      -            },
      -            "required": [
      -              "productIds"
      -            ],
      -            "title": "Open Api Promotion Selected Products",
      -            "type": "object"
      -          },
      -          "code": {
      -            "type": "string"
      -          },
      -          "discount": {
      -            "oneOf": [
      -              {
      -                "allOf": [
      -                  {
      -                    "properties": {
      -                      "type": {
      -                        "type": "string"
      -                      }
      -                    },
      -                    "required": [
      -                      "type"
      -                    ],
      -                    "title": "Shop"
      -                  },
      -                  {
      -                    "properties": {
      -                      "freeShipping": {
      -                        "type": "boolean"
      -                      },
      -                      "money": {
      -                        "properties": {
      -                          "currency": {
      -                            "type": "string"
      -                          },
      -                          "value": {
      -                            "minimum": 0,
      -                            "type": "number"
      -                          }
      -                        },
      -                        "required": [
      -                          "currency",
      -                          "value"
      -                        ],
      -                        "title": "Money",
      -                        "type": "object"
      -                      }
      -                    },
      -                    "type": "object"
      -                  },
      -                  {
      -                    "properties": {
      -                      "type": {
      -                        "const": "FLAT_RATE",
      -                        "type": "string"
      -                      }
      -                    },
      -                    "type": "object"
      -                  }
      -                ],
      -                "required": [
      -                  "freeShipping",
      -                  "money"
      -                ],
      -                "title": "Fixed Amount"
      -              },
      -              {
      -                "allOf": [
      -                  {
      -                    "properties": {
      -                      "type": {
      -                        "type": "string"
      -                      }
      -                    },
      -                    "required": [
      -                      "type"
      -                    ],
      -                    "title": "Shop"
      -                  },
      -                  {
      -                    "properties": {
      -                      "type": {
      -                        "const": "FREE_SHIPPING",
      -                        "type": "string"
      -                      }
      -                    },
      -                    "type": "object"
      -                  }
      -                ],
      -                "title": "Free Shipping"
      -              },
      -              {
      -                "allOf": [
      -                  {
      -                    "properties": {
      -                      "type": {
      -                        "type": "string"
      -                      }
      -                    },
      -                    "required": [
      -                      "type"
      -                    ],
      -                    "title": "Shop"
      -                  },
      -                  {
      -                    "properties": {
      -                      "percentage": {
      -                        "type": "number"
      -                      },
      -                      "shipping": {
      -                        "enum": [
      -                          "Excluded",
      -                          "Included",
      -                          "FreeLowestOnly",
      -                          "Free"
      -                        ],
      -                        "type": "string"
      -                      }
      -                    },
      -                    "type": "object"
      -                  },
      -                  {
      -                    "properties": {
      -                      "type": {
      -                        "const": "PERCENTAGE",
      -                        "type": "string"
      -                      }
      -                    },
      -                    "type": "object"
      -                  }
      -                ],
      -                "required": [
      -                  "percentage",
      -                  "shipping"
      -                ],
      -                "title": "Percentage"
      -              }
      -            ]
      -          },
      -          "limits": {
      -            "properties": {
      -              "maximumUse": {
      -                "format": "int32",
      -                "type": "integer"
      -              },
      -              "oneUsePerCustomer": {
      -                "type": "boolean"
      -              }
      -            },
      -            "required": [
      -              "oneUsePerCustomer"
      -            ],
      -            "title": "Open Api Promotion Limits",
      -            "type": "object"
      -          },
      -          "requirements": {
      -            "properties": {
      -              "minimumOrderValue": {
      -                "properties": {
      -                  "currency": {
      -                    "type": "string"
      -                  },
      -                  "value": {
      -                    "minimum": 0,
      -                    "type": "number"
      -                  }
      -                },
      -                "required": [
      -                  "currency",
      -                  "value"
      -                ],
      -                "title": "Money",
      -                "type": "object"
      -              }
      -            },
      -            "title": "Shop",
      -            "type": "object"
      -          }
      -        },
      -        "type": "object"
      -      },
      -      {
      -        "properties": {
      -          "type": {
      -            "const": "SHOP_SINGLE",
      -            "type": "string"
      -          }
      -        },
      -        "type": "object"
      -      }
      -    ],
      -    "required": [
      -      "code",
      -      "discount"
      -    ],
      -    "title": "SHOP_SINGLE"
      -  }
      -]New value: +[
      +  {
      +    "allOf": [
      +      {
      +        "properties": {
      +          "type": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "type"
      +        ],
      +        "title": "Open Api Create Promotion Request"
      +      },
      +      {
      +        "properties": {
      +          "codes": {
      +            "items": {
      +              "type": "string"
      +            },
      +            "type": "array"
      +          },
      +          "discount": {
      +            "$ref": "#/$defs/discount_2"
      +          },
      +          "requirements": {
      +            "properties": {
      +              "newMembersOnly": {
      +                "type": "boolean"
      +              }
      +            },
      +            "required": [
      +              "newMembersOnly"
      +            ],
      +            "title": "Memberships",
      +            "type": "object"
      +          },
      +          "subscriptionType": {
      +            "$ref": "#/$defs/subscriptionType"
      +          },
      +          "tiers": {
      +            "$ref": "#/$defs/tiers"
      +          }
      +        },
      +        "type": "object"
      +      },
      +      {
      +        "properties": {
      +          "type": {
      +            "const": "MEMBERSHIPS_MULTI",
      +            "type": "string"
      +          }
      +        },
      +        "type": "object"
      +      }
      +    ],
      +    "required": [
      +      "codes",
      +      "discount"
      +    ],
      +    "title": "MEMBERSHIPS_MULTI"
      +  },
      +  {
      +    "allOf": [
      +      {
      +        "properties": {
      +          "type": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "type"
      +        ],
      +        "title": "Open Api Create Promotion Request"
      +      },
      +      {
      +        "properties": {
      +          "code": {
      +            "type": "string"
      +          },
      +          "discount": {
      +            "$ref": "#/$defs/discount_2"
      +          },
      +          "requirements": {
      +            "properties": {
      +              "newMembersOnly": {
      +                "type": "boolean"
      +              }
      +            },
      +            "required": [
      +              "newMembersOnly"
      +            ],
      +            "title": "Memberships",
      +            "type": "object"
      +          },
      +          "subscriptionType": {
      +            "$ref": "#/$defs/subscriptionType"
      +          },
      +          "tiers": {
      +            "$ref": "#/$defs/tiers"
      +          }
      +        },
      +        "type": "object"
      +      },
      +      {
      +        "properties": {
      +          "type": {
      +            "const": "MEMBERSHIPS_SINGLE",
      +            "type": "string"
      +          }
      +        },
      +        "type": "object"
      +      }
      +    ],
      +    "required": [
      +      "code",
      +      "discount"
      +    ],
      +    "title": "MEMBERSHIPS_SINGLE"
      +  },
      +  {
      +    "allOf": [
      +      {
      +        "properties": {
      +          "type": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "type"
      +        ],
      +        "title": "Open Api Create Promotion Request"
      +      },
      +      {
      +        "properties": {
      +          "appliesToProducts": {
      +            "$ref": "#/$defs/Open_Api_Promotion_Selected_Products"
      +          },
      +          "codes": {
      +            "items": {
      +              "type": "string"
      +            },
      +            "type": "array"
      +          },
      +          "discount": {
      +            "$ref": "#/$defs/discount"
      +          },
      +          "limits": {
      +            "properties": {
      +              "maximumUse": {
      +                "format": "int32",
      +                "type": "integer"
      +              },
      +              "oneUsePerCustomer": {
      +                "type": "boolean"
      +              }
      +            },
      +            "required": [
      +              "oneUsePerCustomer"
      +            ],
      +            "title": "Open Api Promotion Limits",
      +            "type": "object"
      +          },
      +          "requirements": {
      +            "$ref": "#/$defs/Shop"
      +          }
      +        },
      +        "type": "object"
      +      },
      +      {
      +        "properties": {
      +          "type": {
      +            "const": "SHOP_MULTI",
      +            "type": "string"
      +          }
      +        },
      +        "type": "object"
      +      }
      +    ],
      +    "required": [
      +      "codes",
      +      "discount"
      +    ],
      +    "title": "SHOP_MULTI"
      +  },
      +  {
      +    "allOf": [
      +      {
      +        "properties": {
      +          "type": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "type"
      +        ],
      +        "title": "Open Api Create Promotion Request"
      +      },
      +      {
      +        "properties": {
      +          "appliesToProducts": {
      +            "$ref": "#/$defs/Open_Api_Promotion_Selected_Products"
      +          },
      +          "code": {
      +            "type": "string"
      +          },
      +          "discount": {
      +            "$ref": "#/$defs/discount"
      +          },
      +          "limits": {
      +            "properties": {
      +              "maximumUse": {
      +                "format": "int32",
      +                "type": "integer"
      +              },
      +              "oneUsePerCustomer": {
      +                "type": "boolean"
      +              }
      +            },
      +            "required": [
      +              "oneUsePerCustomer"
      +            ],
      +            "title": "Open Api Promotion Limits",
      +            "type": "object"
      +          },
      +          "requirements": {
      +            "$ref": "#/$defs/Shop"
      +          }
      +        },
      +        "type": "object"
      +      },
      +      {
      +        "properties": {
      +          "type": {
      +            "const": "SHOP_SINGLE",
      +            "type": "string"
      +          }
      +        },
      +        "type": "object"
      +      }
      +    ],
      +    "required": [
      +      "code",
      +      "discount"
      +    ],
      +    "title": "SHOP_SINGLE"
      +  }
      +]
  2. First observedv2.0.0

TDQS

B3.2/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=false, destructiveHint=true, idempotentHint=false, and openWorldHint=true, so the write/destructive safety profile is covered. The description usefully adds the rate limit (100 requests/10 seconds per shop), but does not explain destructive effects, auth requirements, or other side effects beyond the annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two short sentences with no filler; the rate-limit constraint is front-loaded. The purpose sentence 'Creates a promotion' restates the title and name, so it earns slightly less than full marks for value density.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the rich schema coverage and existing annotations, the description is minimally adequate. However, it does not help an agent navigate the complex payload variants or frame the create operation beyond a bare statement and rate limit. No output schema exists, but return values are not the main gap here.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the structured schema already documents the parameters, making 3 the baseline. The description adds no parameter-level meaning such as payload variant selection or confirm semantics. The complex oneOf payload alternatives are left entirely to the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource: 'Creates a promotion'. It does not explicitly differentiate from sibling tools like update_promotion or get_promotion, so it falls short of full sibling differentiation. The rate-limit line is peripheral to purpose.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance on when to use this tool versus alternatives such as update_promotion or get_promotion, and no prerequisites or exclusions are given. Usage is only implied by the tool name. The sole context provided is a rate-limit note.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools